swup 4.2.0 → 4.3.1

package/dist/types/modules/Visit.d.ts

@@ -1,77 +1,80 @@
-import Swup, { Options } from '../Swup.js';
-import { HistoryAction, HistoryDirection } from './navigate.js';
-/** An object holding details about the current visit. */
-export interface Visit {
-    /** The previous page, about to leave */
-    from: VisitFrom;
-    /** The next page, about to enter */
-    to: VisitTo;
-    /** The content containers, about to be replaced */
-    containers: Options['containers'];
-    /** Information about animated page transitions */
-    animation: VisitAnimation;
-    /** What triggered this visit */
-    trigger: VisitTrigger;
-    /** Browser history behavior on this visit */
-    history: VisitHistory;
-    /** Scroll behavior on this visit */
-    scroll: VisitScroll;
-}
-export interface VisitFrom {
-    /** The URL of the previous page */
-    url: string;
-}
-export interface VisitTo {
-    /** The URL of the next page */
-    url: string;
-    /** The hash of the next page */
-    hash?: string;
-    /** The HTML content of the next page */
-    html?: string;
-}
-export interface VisitAnimation {
-    /** Whether this visit is animated. Default: `true` */
-    animate: boolean;
-    /** Whether to wait for the next page to load before starting the animation. Default: `false` */
-    wait: boolean;
-    /** Name of a custom animation to run. */
-    name?: string;
-    /** Elements on which to add animation classes. Default: `html` element */
-    scope: 'html' | 'containers' | string[];
-    /** Selector for detecting animation timing. Default: `[class*="transition-"]` */
-    selector: Options['animationSelector'];
-}
-export interface VisitScroll {
-    /** Whether to reset the scroll position after the visit. Default: `true` */
-    reset: boolean;
-    /** Anchor element to scroll to on the next page. */
-    target?: string;
-}
-export interface VisitTrigger {
-    /** DOM element that triggered this visit. */
-    el?: Element;
-    /** DOM event that triggered this visit. */
-    event?: Event;
-}
-export interface VisitHistory {
-    /** History action to perform: `push` for creating a new history entry, `replace` for replacing the current entry. Default: `push` */
-    action: HistoryAction;
-    /** Whether this visit was triggered by a browser history navigation. */
-    popstate: boolean;
-    /** The direction of travel in case of a browser history navigation: backward or forward. */
-    direction: HistoryDirection | undefined;
-}
-export interface VisitInitOptions {
-    to: string;
-    from?: string;
-    hash?: string;
-    animate?: boolean;
-    animation?: string;
-    targets?: string[];
-    el?: Element;
-    event?: Event;
-    action?: HistoryAction;
-    resetScroll?: boolean;
-}
-/** Create a new visit object. */
-export declare function createVisit(this: Swup, { to, from, hash, animate, animation: name, el, event, action, resetScroll: reset }: VisitInitOptions): Visit;
+import Swup, { Options } from '../Swup.js';
+import { HistoryAction, HistoryDirection } from './navigate.js';
+/** An object holding details about the current visit. */
+export interface Visit {
+    /** The previous page, about to leave */
+    from: VisitFrom;
+    /** The next page, about to enter */
+    to: VisitTo;
+    /** The content containers, about to be replaced */
+    containers: Options['containers'];
+    /** Information about animated page transitions */
+    animation: VisitAnimation;
+    /** What triggered this visit */
+    trigger: VisitTrigger;
+    /** Cache behavior for this visit */
+    cache: VisitCache;
+    /** Browser history behavior on this visit */
+    history: VisitHistory;
+    /** Scroll behavior on this visit */
+    scroll: VisitScroll;
+}
+export interface VisitFrom {
+    /** The URL of the previous page */
+    url: string;
+}
+export interface VisitTo {
+    /** The URL of the next page */
+    url: string;
+    /** The hash of the next page */
+    hash?: string;
+    /** The HTML content of the next page */
+    html?: string;
+}
+export interface VisitAnimation {
+    /** Whether this visit is animated. Default: `true` */
+    animate: boolean;
+    /** Whether to wait for the next page to load before starting the animation. Default: `false` */
+    wait: boolean;
+    /** Name of a custom animation to run. */
+    name?: string;
+    /** Elements on which to add animation classes. Default: `html` element */
+    scope: 'html' | 'containers' | string[];
+    /** Selector for detecting animation timing. Default: `[class*="transition-"]` */
+    selector: Options['animationSelector'];
+}
+export interface VisitScroll {
+    /** Whether to reset the scroll position after the visit. Default: `true` */
+    reset: boolean;
+    /** Anchor element to scroll to on the next page. */
+    target?: string | false;
+}
+export interface VisitTrigger {
+    /** DOM element that triggered this visit. */
+    el?: Element;
+    /** DOM event that triggered this visit. */
+    event?: Event;
+}
+export interface VisitCache {
+    /** Whether this visit will try to load the requested page from cache. */
+    read: boolean;
+    /** Whether this visit will save the loaded page in cache. */
+    write: boolean;
+}
+export interface VisitHistory {
+    /** History action to perform: `push` for creating a new history entry, `replace` for replacing the current entry. Default: `push` */
+    action: HistoryAction;
+    /** Whether this visit was triggered by a browser history navigation. */
+    popstate: boolean;
+    /** The direction of travel in case of a browser history navigation: backward or forward. */
+    direction: HistoryDirection | undefined;
+}
+export interface VisitInitOptions {
+    to: string;
+    from?: string;
+    hash?: string;
+    el?: Element;
+    event?: Event;
+}
+/** Create a new visit object. */
+export declare function createVisit(this: Swup, { to, from, hash, el, event }: VisitInitOptions): Visit;

package/dist/types/modules/__test__/cache.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/types/modules/__test__/{delegateEvent.d.ts → delegateEvent.test.d.ts}

@@ -1 +1 @@
-export {};
+export {};

package/dist/types/modules/__test__/hooks.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/types/modules/__test__/plugins.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/types/modules/__test__/replaceContent.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/types/modules/animatePageIn.d.ts

@@ -1,6 +1,6 @@
-import Swup from '../Swup.js';
-/**
- * Perform the in/enter animation of the next page.
- * @returns Promise<void>
- */
-export declare const animatePageIn: (this: Swup) => Promise<void>;
+import Swup from '../Swup.js';
+/**
+ * Perform the in/enter animation of the next page.
+ * @returns Promise<void>
+ */
+export declare const animatePageIn: (this: Swup) => Promise<void>;

package/dist/types/modules/animatePageOut.d.ts

@@ -1,6 +1,6 @@
-import Swup from '../Swup.js';
-/**
- * Perform the out/leave animation of the current page.
- * @returns Promise<void>
- */
-export declare const animatePageOut: (this: Swup) => Promise<void>;
+import Swup from '../Swup.js';
+/**
+ * Perform the out/leave animation of the current page.
+ * @returns Promise<void>
+ */
+export declare const animatePageOut: (this: Swup) => Promise<void>;

package/dist/types/modules/awaitAnimations.d.ts

@@ -1,19 +1,19 @@
-import Swup, { Options } from '../Swup.js';
-declare const TRANSITION = "transition";
-declare const ANIMATION = "animation";
-type AnimationTypes = typeof TRANSITION | typeof ANIMATION;
-export type AnimationDirection = 'in' | 'out';
-/**
- * Return a Promise that resolves when all CSS animations and transitions
- * are done on the page. Filters by selector or takes elements directly.
- */
-export declare function awaitAnimations(this: Swup, { elements, selector }: {
-    selector: Options['animationSelector'];
-    elements?: NodeListOf<HTMLElement> | HTMLElement[];
-}): Promise<void>;
-export declare function getTransitionInfo(element: Element, expectedType?: AnimationTypes): {
-    type: AnimationTypes | null;
-    timeout: number;
-    propCount: number;
-};
-export {};
+import Swup, { Options } from '../Swup.js';
+declare const TRANSITION = "transition";
+declare const ANIMATION = "animation";
+type AnimationTypes = typeof TRANSITION | typeof ANIMATION;
+export type AnimationDirection = 'in' | 'out';
+/**
+ * Return a Promise that resolves when all CSS animations and transitions
+ * are done on the page. Filters by selector or takes elements directly.
+ */
+export declare function awaitAnimations(this: Swup, { elements, selector }: {
+    selector: Options['animationSelector'];
+    elements?: NodeListOf<HTMLElement> | HTMLElement[];
+}): Promise<void>;
+export declare function getTransitionInfo(element: Element, expectedType?: AnimationTypes): {
+    type: AnimationTypes | null;
+    timeout: number;
+    propCount: number;
+};
+export {};

package/dist/types/modules/fetchPage.d.ts

@@ -1,29 +1,27 @@
-import Swup from '../Swup.js';
-/** A page object as used by swup and its cache. */
-export interface PageData {
-    /** The URL of the page */
-    url: string;
-    /** The complete HTML response received from the server */
-    html: string;
-}
-/** Define how a page is fetched. */
-export interface FetchOptions extends RequestInit {
-    /** The request method. */
-    method?: 'GET' | 'POST';
-    /** The body of the request: raw string, form data object or URL params. */
-    body?: string | FormData | URLSearchParams;
-    /** The headers of the request: key/value object. */
-    headers?: Record<string, string>;
-}
-export declare class FetchError extends Error {
-    url: string;
-    status: number;
-    constructor(message: string, details: {
-        url: string;
-        status: number;
-    });
-}
-/**
- * Fetch a page from the server, return it and cache it.
- */
-export declare function fetchPage(this: Swup, url: URL | string, options?: FetchOptions): Promise<PageData>;
+import Swup from '../Swup.js';
+/** A page object as used by swup and its cache. */
+export interface PageData {
+    /** The URL of the page */
+    url: string;
+    /** The complete HTML response received from the server */
+    html: string;
+}
+/** Define how a page is fetched. */
+export interface FetchOptions extends Omit<RequestInit, 'cache'> {
+    /** The request method. */
+    method?: 'GET' | 'POST';
+    /** The body of the request: raw string, form data object or URL params. */
+    body?: string | FormData | URLSearchParams;
+}
+export declare class FetchError extends Error {
+    url: string;
+    status: number;
+    constructor(message: string, details: {
+        url: string;
+        status: number;
+    });
+}
+/**
+ * Fetch a page from the server, return it and cache it.
+ */
+export declare function fetchPage(this: Swup, url: URL | string, options?: FetchOptions): Promise<PageData>;

package/dist/types/modules/getAnchorElement.d.ts

@@ -1,9 +1,9 @@
-/**
- * Find the anchor element for a given hash.
- *
- * @param hash Hash with or without leading '#'
- * @returns The element, if found, or null.
- *
- * @see https://html.spec.whatwg.org/#find-a-potential-indicated-element
- */
-export declare const getAnchorElement: (hash?: string) => Element | null;
+/**
+ * Find the anchor element for a given hash.
+ *
+ * @param hash Hash with or without leading '#'
+ * @returns The element, if found, or null.
+ *
+ * @see https://html.spec.whatwg.org/#find-a-potential-indicated-element
+ */
+export declare const getAnchorElement: (hash?: string) => Element | null;

package/dist/types/modules/navigate.d.ts

@@ -1,35 +1,41 @@
-import Swup from '../Swup.js';
-import { FetchOptions } from './fetchPage.js';
-import { VisitInitOptions } from './Visit.js';
-export type HistoryAction = 'push' | 'replace';
-export type HistoryDirection = 'forwards' | 'backwards';
-export type NavigationToSelfAction = 'scroll' | 'navigate';
-/** Define how to navigate to a page. */
-type NavigationOptions = {
-    /** Whether this visit is animated. Default: `true` */
-    animate?: boolean;
-    /** Name of a custom animation to run. */
-    animation?: string;
-    /** History action to perform: `push` for creating a new history entry, `replace` for replacing the current entry. Default: `push` */
-    history?: HistoryAction;
-};
-/**
- * Navigate to a new URL.
- * @param url The URL to navigate to.
- * @param options Options for how to perform this visit.
- * @returns Promise<void>
- */
-export declare function navigate(this: Swup, url: string, options?: NavigationOptions & FetchOptions, init?: Omit<VisitInitOptions, 'to'>): void;
-/**
- * Start a visit to a new URL.
- *
- * Internal method that assumes the visit context has already been created.
- *
- * As a user, you should call `swup.navigate(url)` instead.
- *
- * @param url The URL to navigate to.
- * @param options Options for how to perform this visit.
- * @returns Promise<void>
- */
-export declare function performNavigation(this: Swup, options?: NavigationOptions & FetchOptions): Promise<void>;
-export {};
+import Swup from '../Swup.js';
+import { FetchOptions } from './fetchPage.js';
+import { VisitInitOptions } from './Visit.js';
+export type HistoryAction = 'push' | 'replace';
+export type HistoryDirection = 'forwards' | 'backwards';
+export type NavigationToSelfAction = 'scroll' | 'navigate';
+export type CacheControl = Partial<{
+    read: boolean;
+    write: boolean;
+}>;
+/** Define how to navigate to a page. */
+type NavigationOptions = {
+    /** Whether this visit is animated. Default: `true` */
+    animate?: boolean;
+    /** Name of a custom animation to run. */
+    animation?: string;
+    /** History action to perform: `push` for creating a new history entry, `replace` for replacing the current entry. Default: `push` */
+    history?: HistoryAction;
+    /** Whether this visit should read from or write to the cache. */
+    cache?: CacheControl;
+};
+/**
+ * Navigate to a new URL.
+ * @param url The URL to navigate to.
+ * @param options Options for how to perform this visit.
+ * @returns Promise<void>
+ */
+export declare function navigate(this: Swup, url: string, options?: NavigationOptions & FetchOptions, init?: Omit<VisitInitOptions, 'to'>): void;
+/**
+ * Start a visit to a new URL.
+ *
+ * Internal method that assumes the visit context has already been created.
+ *
+ * As a user, you should call `swup.navigate(url)` instead.
+ *
+ * @param url The URL to navigate to.
+ * @param options Options for how to perform this visit.
+ * @returns Promise<void>
+ */
+export declare function performNavigation(this: Swup, options?: NavigationOptions & FetchOptions): Promise<void>;
+export {};

package/dist/types/modules/plugins.d.ts

@@ -1,26 +1,26 @@
-import Swup from '../Swup.js';
-export type Plugin = {
-    /** Identify as a swup plugin */
-    isSwupPlugin: true;
-    /** Name of this plugin */
-    name: string;
-    /** Version of this plugin. Currently not in use, defined here for backward compatiblity. */
-    version?: string;
-    /** The swup instance that mounted this plugin */
-    swup?: Swup;
-    /** Version requirements of this plugin. Example: `{ swup: '>=4' }` */
-    requires?: Record<string, string | string[]>;
-    /** Run on mount */
-    mount: () => void;
-    /** Run on unmount */
-    unmount: () => void;
-    _beforeMount?: () => void;
-    _afterUnmount?: () => void;
-    _checkRequirements?: () => boolean;
-};
-/** Install a plugin. */
-export declare const use: (this: Swup, plugin: unknown) => Plugin[] | undefined;
-/** Uninstall a plugin. */
-export declare function unuse(this: Swup, pluginOrName: Plugin | string): Plugin[] | undefined;
-/** Find a plugin by name or reference. */
-export declare function findPlugin(this: Swup, pluginOrName: Plugin | string): Plugin | undefined;
+import Swup from '../Swup.js';
+export type Plugin = {
+    /** Identify as a swup plugin */
+    isSwupPlugin: true;
+    /** Name of this plugin */
+    name: string;
+    /** Version of this plugin. Currently not in use, defined here for backward compatiblity. */
+    version?: string;
+    /** The swup instance that mounted this plugin */
+    swup?: Swup;
+    /** Version requirements of this plugin. Example: `{ swup: '>=4' }` */
+    requires?: Record<string, string | string[]>;
+    /** Run on mount */
+    mount: () => void;
+    /** Run on unmount */
+    unmount: () => void;
+    _beforeMount?: () => void;
+    _afterUnmount?: () => void;
+    _checkRequirements?: () => boolean;
+};
+/** Install a plugin. */
+export declare const use: (this: Swup, plugin: unknown) => Plugin[] | undefined;
+/** Uninstall a plugin. */
+export declare function unuse(this: Swup, pluginOrName: Plugin | string): Plugin[] | undefined;
+/** Find a plugin by name or reference. */
+export declare function findPlugin(this: Swup, pluginOrName: Plugin | string): Plugin | undefined;

package/dist/types/modules/renderPage.d.ts

@@ -1,7 +1,7 @@
-import Swup from '../Swup.js';
-import { PageData } from './fetchPage.js';
-/**
- * Render the next page: replace the content and update scroll position.
- * @returns Promise<void>
- */
-export declare const renderPage: (this: Swup, requestedUrl: string, page: PageData) => Promise<void>;
+import Swup from '../Swup.js';
+import { PageData } from './fetchPage.js';
+/**
+ * Render the next page: replace the content and update scroll position.
+ * @returns Promise<void>
+ */
+export declare const renderPage: (this: Swup, requestedUrl: string, page: PageData) => Promise<void>;

package/dist/types/modules/replaceContent.d.ts

@@ -1,13 +1,13 @@
-import Swup, { Options } from '../Swup.js';
-import { PageData } from './fetchPage.js';
-/**
- * Perform the replacement of content after loading a page.
- *
- * It takes an object with the page data as returned from `fetchPage` and a list
- * of container selectors to replace.
- *
- * @returns Whether all containers were replaced.
- */
-export declare const replaceContent: (this: Swup, { html }: PageData, { containers }?: {
-    containers: Options['containers'];
-}) => boolean;
+import Swup, { Options } from '../Swup.js';
+import { PageData } from './fetchPage.js';
+/**
+ * Perform the replacement of content after loading a page.
+ *
+ * It takes an object with the page data as returned from `fetchPage` and a list
+ * of container selectors to replace.
+ *
+ * @returns Whether all containers were replaced.
+ */
+export declare const replaceContent: (this: Swup, { html }: PageData, { containers }?: {
+    containers: Options['containers'];
+}) => boolean;

package/dist/types/modules/resolveUrl.d.ts

@@ -1,14 +1,14 @@
-import Swup from '../Swup.js';
-/**
- * Utility function to validate and run the global option 'resolveUrl'
- * @param {string} url
- * @returns {string} the resolved url
- */
-export declare function resolveUrl(this: Swup, url: string): string;
-/**
- * Compares the resolved version of two paths and returns true if they are the same
- * @param {string} url1
- * @param {string} url2
- * @returns {boolean}
- */
-export declare function isSameResolvedUrl(this: Swup, url1: string, url2: string): boolean;
+import Swup from '../Swup.js';
+/**
+ * Utility function to validate and run the global option 'resolveUrl'
+ * @param {string} url
+ * @returns {string} the resolved url
+ */
+export declare function resolveUrl(this: Swup, url: string): string;
+/**
+ * Compares the resolved version of two paths and returns true if they are the same
+ * @param {string} url1
+ * @param {string} url2
+ * @returns {boolean}
+ */
+export declare function isSameResolvedUrl(this: Swup, url1: string, url2: string): boolean;

package/dist/types/modules/scrollToContent.d.ts

@@ -1,6 +1,6 @@
-import Swup from '../Swup.js';
-/**
- * Update the scroll position after page render.
- * @returns Promise<boolean>
- */
-export declare const scrollToContent: (this: Swup) => boolean;
+import Swup from '../Swup.js';
+/**
+ * Update the scroll position after page render.
+ * @returns Promise<boolean>
+ */
+export declare const scrollToContent: (this: Swup) => boolean;

package/dist/types/utils/index.d.ts

@@ -1,20 +1,20 @@
-/** Find an element by selector. */
-export declare const query: (selector: string, context?: Document | Element) => HTMLElement | null;
-/** Find a set of elements by selector. */
-export declare const queryAll: (selector: string, context?: Document | Element) => HTMLElement[];
-/** Return a Promise that resolves after the next event loop. */
-export declare const nextTick: () => Promise<void>;
-/** Check if an object is a Promise or a Thenable */
-export declare function isPromise<T>(obj: any): obj is PromiseLike<T>;
-/** Call a function as a Promise. Resolves with the returned Promsise or immediately. */
-export declare function runAsPromise(func: Function, args?: any[]): Promise<any>;
-/**
- * Force a layout reflow, e.g. after adding classnames
- * @returns The offset height, just here so it doesn't get optimized away by the JS engine
- * @see https://stackoverflow.com/a/21665117/3759615
- */
-export declare function forceReflow(element?: HTMLElement): number;
-/** Escape a string with special chars to not break CSS selectors. */
-export declare const escapeCssIdentifier: (ident: string) => string;
-/** Fix for Chrome below v61 formatting CSS floats with comma in some locales. */
-export declare const toMs: (s: string) => number;
+/** Find an element by selector. */
+export declare const query: (selector: string, context?: Document | Element) => HTMLElement | null;
+/** Find a set of elements by selector. */
+export declare const queryAll: (selector: string, context?: Document | Element) => HTMLElement[];
+/** Return a Promise that resolves after the next event loop. */
+export declare const nextTick: () => Promise<void>;
+/** Check if an object is a Promise or a Thenable */
+export declare function isPromise<T>(obj: unknown): obj is PromiseLike<T>;
+/** Call a function as a Promise. Resolves with the returned Promsise or immediately. */
+export declare function runAsPromise(func: Function, args?: unknown[]): Promise<unknown>;
+/**
+ * Force a layout reflow, e.g. after adding classnames
+ * @returns The offset height, just here so it doesn't get optimized away by the JS engine
+ * @see https://stackoverflow.com/a/21665117/3759615
+ */
+export declare function forceReflow(element?: HTMLElement): number;
+/** Escape a string with special chars to not break CSS selectors. */
+export declare const escapeCssIdentifier: (ident: string) => string;
+/** Fix for Chrome below v61 formatting CSS floats with comma in some locales. */
+export declare const toMs: (s: string) => number;

package/dist/types/utils.d.ts

@@ -1 +1 @@
-export * from './utils/index.js';
+export * from './utils/index.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "swup",
   "amdName": "Swup",
-  "version": "4.2.0",
+  "version": "4.3.1",
   "description": "Versatile and extensible page transition library for server-rendered websites",
   "type": "module",
   "source": "./src/Swup.ts",
@@ -26,9 +26,10 @@
     "build:module": "BROWSERSLIST_ENV=modern microbundle src/index.ts -f modern,esm,cjs",
     "build:bundle": "BROWSERSLIST_ENV=production microbundle src/Swup.ts -f umd --external none",
     "dev": "npm run clean && BROWSERSLIST_ENV=development microbundle src/index.ts -w -f modern",
-    "lint": "npm run lint:ts && npm run lint:prettier -- --check",
-    "format": "npm run lint:ts && npm run lint:prettier -- --write",
+    "format": "npx eslint . --fix",
+    "lint": "npm run lint:ts && npm run lint:es",
     "lint:ts": "tsc --noEmit --skipLibCheck",
+    "lint:es": "npx eslint .",
     "lint:prettier": "prettier 'src/**/*.ts'",
     "prepublishOnly": "npm run build",
     "postinstall": "opencollective-postinstall || true",
@@ -70,7 +71,12 @@
     "@swup/browserslist-config": "^1.0.0",
     "@swup/prettier-config": "^1.0.0",
     "@types/jsdom": "^21.1.1",
+    "@typescript-eslint/eslint-plugin": "^6.3.0",
+    "@typescript-eslint/parser": "^6.3.0",
     "cypress": "^12.3.0",
+    "eslint": "^8.46.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^4.2.1",
     "http-server": "^14.1.1",
     "husky": "^8.0.0",
     "istanbul-lib-coverage": "^3.2.0",