swup 4.2.0 → 4.3.1

package/dist/types/Swup.d.ts

@@ -1,119 +1,119 @@
-import { DelegateEvent } from 'delegate-it';
-import { DelegateEventUnsubscribe } from './helpers/delegateEvent.js';
-import { Cache } from './modules/Cache.js';
-import { Classes } from './modules/Classes.js';
-import { Visit, createVisit } from './modules/Visit.js';
-import { Hooks } from './modules/Hooks.js';
-import { awaitAnimations } from './modules/awaitAnimations.js';
-import { navigate, performNavigation, NavigationToSelfAction } from './modules/navigate.js';
-import { fetchPage } from './modules/fetchPage.js';
-import { unuse, findPlugin, Plugin } from './modules/plugins.js';
-import { isSameResolvedUrl, resolveUrl } from './modules/resolveUrl.js';
-/** Options for customizing swup's behavior. */
-export type Options = {
-    /** Whether history visits are animated. Default: `false` */
-    animateHistoryBrowsing: boolean;
-    /** Selector for detecting animation timing. Default: `[class*="transition-"]` */
-    animationSelector: string | false;
-    /** Elements on which to add animation classes. Default: `html` element */
-    animationScope: 'html' | 'containers';
-    /** Enable in-memory page cache. Default: `true` */
-    cache: boolean;
-    /** Content containers to be replaced on page visits. Default: `['#swup']` */
-    containers: string[];
-    /** Callback for ignoring visits. Receives the element and event that triggered the visit. */
-    ignoreVisit: (url: string, { el, event }: {
-        el?: Element;
-        event?: Event;
-    }) => boolean;
-    /** Selector for links that trigger visits. Default: `'a[href]'` */
-    linkSelector: string;
-    /** How swup handles links to the same page. Default: `scroll` */
-    linkToSelf: NavigationToSelfAction;
-    /** Plugins to register on startup. */
-    plugins: Plugin[];
-    /** Custom headers sent along with fetch requests. */
-    requestHeaders: Record<string, string>;
-    /** Rewrite URLs before loading them. */
-    resolveUrl: (url: string) => string;
-    /** Callback for telling swup to ignore certain popstate events.  */
-    skipPopStateHandling: (event: any) => boolean;
-};
-/** Swup page transition library. */
-export default class Swup {
-    /** Library version */
-    readonly version: string;
-    /** Options passed into the instance */
-    options: Options;
-    /** Default options before merging user options */
-    readonly defaults: Options;
-    /** Registered plugin instances */
-    plugins: Plugin[];
-    /** Data about the current visit */
-    visit: Visit;
-    /** Cache instance */
-    readonly cache: Cache;
-    /** Hook registry */
-    readonly hooks: Hooks;
-    /** Animation class manager */
-    readonly classes: Classes;
-    /** URL of the currently visible page */
-    currentPageUrl: string;
-    /** Index of the current history entry */
-    protected currentHistoryIndex: number;
-    /** Delegated event subscription handle */
-    protected clickDelegate?: DelegateEventUnsubscribe;
-    /** Install a plugin */
-    use: (this: Swup, plugin: unknown) => Plugin[] | undefined;
-    /** Uninstall a plugin */
-    unuse: typeof unuse;
-    /** Find a plugin by name or instance */
-    findPlugin: typeof findPlugin;
-    /** Log a message. Has no effect unless debug plugin is installed */
-    log: (message: string, context?: any) => void;
-    /** Navigate to a new URL */
-    navigate: typeof navigate;
-    /** Actually perform a navigation */
-    protected performNavigation: typeof performNavigation;
-    /** Create a new context for this visit */
-    protected createVisit: typeof createVisit;
-    /** Register a delegated event listener */
-    delegateEvent: <Selector extends string, TElement extends Element = import("typed-query-selector/parser.js").ParseSelector<Selector, HTMLElement>, TEvent extends keyof GlobalEventHandlersEventMap = keyof GlobalEventHandlersEventMap>(selector: Selector, type: TEvent, callback: import("delegate-it").DelegateEventHandler<GlobalEventHandlersEventMap[TEvent], TElement>, options?: import("delegate-it").DelegateOptions | undefined) => DelegateEventUnsubscribe;
-    /** Fetch a page from the server */
-    fetchPage: typeof fetchPage;
-    /** Resolve when animations on the page finish */
-    awaitAnimations: typeof awaitAnimations;
-    protected renderPage: (this: Swup, requestedUrl: string, page: import("./modules/fetchPage.js").PageData) => Promise<void>;
-    /** Replace the content after page load */
-    replaceContent: (this: Swup, { html }: import("./modules/fetchPage.js").PageData, { containers }?: {
-        containers: string[];
-    }) => boolean;
-    protected animatePageIn: (this: Swup) => Promise<void>;
-    protected animatePageOut: (this: Swup) => Promise<void>;
-    protected scrollToContent: (this: Swup) => boolean;
-    /** Find the anchor element for a given hash */
-    getAnchorElement: (hash?: string | undefined) => Element | null;
-    /** Get the current page URL */
-    getCurrentUrl: ({ hash }?: {
-        hash?: boolean | undefined;
-    }) => string;
-    /** Resolve a URL to its final location */
-    resolveUrl: typeof resolveUrl;
-    /** Check if two URLs resolve to the same location */
-    protected isSameResolvedUrl: typeof isSameResolvedUrl;
-    constructor(options?: Partial<Options>);
-    protected checkRequirements(): boolean;
-    /** Enable this instance, adding listeners and classnames. */
-    enable(): Promise<void>;
-    /** Disable this instance, removing listeners and classnames. */
-    destroy(): Promise<void>;
-    /** Determine if a visit should be ignored by swup, based on URL or trigger element. */
-    shouldIgnoreVisit(href: string, { el, event }?: {
-        el?: Element;
-        event?: Event;
-    }): boolean;
-    protected handleLinkClick(event: DelegateEvent<MouseEvent>): void;
-    protected handlePopState(event: PopStateEvent): void;
-    /** Determine whether an element will open a new tab when clicking/activating. */
-    protected triggerWillOpenNewWindow(triggerEl: Element): boolean;
-}
+import { DelegateEvent } from 'delegate-it';
+import { DelegateEventUnsubscribe } from './helpers/delegateEvent.js';
+import { Cache } from './modules/Cache.js';
+import { Classes } from './modules/Classes.js';
+import { Visit, createVisit } from './modules/Visit.js';
+import { Hooks } from './modules/Hooks.js';
+import { awaitAnimations } from './modules/awaitAnimations.js';
+import { navigate, performNavigation, NavigationToSelfAction } from './modules/navigate.js';
+import { fetchPage } from './modules/fetchPage.js';
+import { unuse, findPlugin, Plugin } from './modules/plugins.js';
+import { isSameResolvedUrl, resolveUrl } from './modules/resolveUrl.js';
+/** Options for customizing swup's behavior. */
+export type Options = {
+    /** Whether history visits are animated. Default: `false` */
+    animateHistoryBrowsing: boolean;
+    /** Selector for detecting animation timing. Default: `[class*="transition-"]` */
+    animationSelector: string | false;
+    /** Elements on which to add animation classes. Default: `html` element */
+    animationScope: 'html' | 'containers';
+    /** Enable in-memory page cache. Default: `true` */
+    cache: boolean;
+    /** Content containers to be replaced on page visits. Default: `['#swup']` */
+    containers: string[];
+    /** Callback for ignoring visits. Receives the element and event that triggered the visit. */
+    ignoreVisit: (url: string, { el, event }: {
+        el?: Element;
+        event?: Event;
+    }) => boolean;
+    /** Selector for links that trigger visits. Default: `'a[href]'` */
+    linkSelector: string;
+    /** How swup handles links to the same page. Default: `scroll` */
+    linkToSelf: NavigationToSelfAction;
+    /** Plugins to register on startup. */
+    plugins: Plugin[];
+    /** Custom headers sent along with fetch requests. */
+    requestHeaders: Record<string, string>;
+    /** Rewrite URLs before loading them. */
+    resolveUrl: (url: string) => string;
+    /** Callback for telling swup to ignore certain popstate events.  */
+    skipPopStateHandling: (event: PopStateEvent) => boolean;
+};
+/** Swup page transition library. */
+export default class Swup {
+    /** Library version */
+    readonly version: string;
+    /** Options passed into the instance */
+    options: Options;
+    /** Default options before merging user options */
+    readonly defaults: Options;
+    /** Registered plugin instances */
+    plugins: Plugin[];
+    /** Data about the current visit */
+    visit: Visit;
+    /** Cache instance */
+    readonly cache: Cache;
+    /** Hook registry */
+    readonly hooks: Hooks;
+    /** Animation class manager */
+    readonly classes: Classes;
+    /** URL of the currently visible page */
+    currentPageUrl: string;
+    /** Index of the current history entry */
+    protected currentHistoryIndex: number;
+    /** Delegated event subscription handle */
+    protected clickDelegate?: DelegateEventUnsubscribe;
+    /** Install a plugin */
+    use: (this: Swup, plugin: unknown) => Plugin[] | undefined;
+    /** Uninstall a plugin */
+    unuse: typeof unuse;
+    /** Find a plugin by name or instance */
+    findPlugin: typeof findPlugin;
+    /** Log a message. Has no effect unless debug plugin is installed */
+    log: (message: string, context?: unknown) => void;
+    /** Navigate to a new URL */
+    navigate: typeof navigate;
+    /** Actually perform a navigation */
+    protected performNavigation: typeof performNavigation;
+    /** Create a new context for this visit */
+    protected createVisit: typeof createVisit;
+    /** Register a delegated event listener */
+    delegateEvent: <Selector extends string, TElement extends Element = import("typed-query-selector/parser.js").ParseSelector<Selector, HTMLElement>, TEvent extends keyof GlobalEventHandlersEventMap = keyof GlobalEventHandlersEventMap>(selector: Selector, type: TEvent, callback: import("delegate-it").DelegateEventHandler<GlobalEventHandlersEventMap[TEvent], TElement>, options?: import("delegate-it").DelegateOptions | undefined) => DelegateEventUnsubscribe;
+    /** Fetch a page from the server */
+    fetchPage: typeof fetchPage;
+    /** Resolve when animations on the page finish */
+    awaitAnimations: typeof awaitAnimations;
+    protected renderPage: (this: Swup, requestedUrl: string, page: import("./modules/fetchPage.js").PageData) => Promise<void>;
+    /** Replace the content after page load */
+    replaceContent: (this: Swup, { html }: import("./modules/fetchPage.js").PageData, { containers }?: {
+        containers: string[];
+    }) => boolean;
+    protected animatePageIn: (this: Swup) => Promise<void>;
+    protected animatePageOut: (this: Swup) => Promise<void>;
+    protected scrollToContent: (this: Swup) => boolean;
+    /** Find the anchor element for a given hash */
+    getAnchorElement: (hash?: string | undefined) => Element | null;
+    /** Get the current page URL */
+    getCurrentUrl: ({ hash }?: {
+        hash?: boolean | undefined;
+    }) => string;
+    /** Resolve a URL to its final location */
+    resolveUrl: typeof resolveUrl;
+    /** Check if two URLs resolve to the same location */
+    protected isSameResolvedUrl: typeof isSameResolvedUrl;
+    constructor(options?: Partial<Options>);
+    protected checkRequirements(): boolean;
+    /** Enable this instance, adding listeners and classnames. */
+    enable(): Promise<void>;
+    /** Disable this instance, removing listeners and classnames. */
+    destroy(): Promise<void>;
+    /** Determine if a visit should be ignored by swup, based on URL or trigger element. */
+    shouldIgnoreVisit(href: string, { el, event }?: {
+        el?: Element;
+        event?: Event;
+    }): boolean;
+    protected handleLinkClick(event: DelegateEvent<MouseEvent>): void;
+    protected handlePopState(event: PopStateEvent): void;
+    /** Determine whether an element will open a new tab when clicking/activating. */
+    protected triggerWillOpenNewWindow(triggerEl: Element): boolean;
+}

package/dist/types/__test__/index.test.d.ts

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

package/dist/types/config/version.d.ts

@@ -1,5 +1,5 @@
-/**
- * Import swup's current version from package.json
- */
-declare const _default: string;
-export default _default;
+/**
+ * Import swup's current version from package.json
+ */
+declare const _default: string;
+export default _default;

package/dist/types/helpers/Location.d.ts

@@ -1,24 +1,24 @@
-/**
- * A helper for creating a Location from either an element
- * or a URL object/string
- *
- */
-export declare class Location extends URL {
-    constructor(url: URL | string, base?: string);
-    /**
-     * The full local path including query params.
-     */
-    get url(): string;
-    /**
-     * Instantiate a Location from an element's href attribute
-     * @param el
-     * @returns new Location instance
-     */
-    static fromElement(el: Element): Location;
-    /**
-     * Instantiate a Location from a URL object or string
-     * @param url
-     * @returns new Location instance
-     */
-    static fromUrl(url: URL | string): Location;
-}
+/**
+ * A helper for creating a Location from either an element
+ * or a URL object/string
+ *
+ */
+export declare class Location extends URL {
+    constructor(url: URL | string, base?: string);
+    /**
+     * The full local path including query params.
+     */
+    get url(): string;
+    /**
+     * Instantiate a Location from an element's href attribute
+     * @param el
+     * @returns new Location instance
+     */
+    static fromElement(el: Element): Location;
+    /**
+     * Instantiate a Location from a URL object or string
+     * @param url
+     * @returns new Location instance
+     */
+    static fromUrl(url: URL | string): Location;
+}

package/dist/types/helpers/__test__/matchPath.test.d.ts

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

package/dist/types/helpers/classify.d.ts

@@ -1,2 +1,2 @@
-/** Turn a string into a slug by lowercasing and replacing whitespace. */
-export declare const classify: (text: string, fallback?: string) => string;
+/** Turn a string into a slug by lowercasing and replacing whitespace. */
+export declare const classify: (text: string, fallback?: string) => string;

package/dist/types/helpers/createHistoryRecord.d.ts

@@ -1,2 +1,9 @@
-/** Create a new history record with a custom swup identifier. */
-export declare const createHistoryRecord: (url: string, customData?: Record<string, unknown>) => void;
+export interface HistoryState {
+    url: string;
+    source: 'swup';
+    random: number;
+    index?: number;
+    [key: string]: unknown;
+}
+/** Create a new history record with a custom swup identifier. */
+export declare const createHistoryRecord: (url: string, customData?: Record<string, unknown>) => void;

package/dist/types/helpers/delegateEvent.d.ts

@@ -1,7 +1,7 @@
-import { DelegateEventHandler, DelegateOptions } from 'delegate-it';
-import { ParseSelector } from 'typed-query-selector/parser.js';
-export type DelegateEventUnsubscribe = {
-    destroy: () => void;
-};
-/** Register a delegated event listener. */
-export declare const delegateEvent: <Selector extends string, TElement extends Element = ParseSelector<Selector, HTMLElement>, TEvent extends keyof GlobalEventHandlersEventMap = keyof GlobalEventHandlersEventMap>(selector: Selector, type: TEvent, callback: DelegateEventHandler<GlobalEventHandlersEventMap[TEvent], TElement>, options?: DelegateOptions) => DelegateEventUnsubscribe;
+import { DelegateEventHandler, DelegateOptions } from 'delegate-it';
+import { ParseSelector } from 'typed-query-selector/parser.js';
+export type DelegateEventUnsubscribe = {
+    destroy: () => void;
+};
+/** Register a delegated event listener. */
+export declare const delegateEvent: <Selector extends string, TElement extends Element = ParseSelector<Selector, HTMLElement>, TEvent extends keyof GlobalEventHandlersEventMap = keyof GlobalEventHandlersEventMap>(selector: Selector, type: TEvent, callback: DelegateEventHandler<GlobalEventHandlersEventMap[TEvent], TElement>, options?: DelegateOptions) => DelegateEventUnsubscribe;

package/dist/types/helpers/getCurrentUrl.d.ts

@@ -1,4 +1,4 @@
-/** Get the current page URL: path name + query params. Optionally including hash. */
-export declare const getCurrentUrl: ({ hash }?: {
-    hash?: boolean | undefined;
-}) => string;
+/** Get the current page URL: path name + query params. Optionally including hash. */
+export declare const getCurrentUrl: ({ hash }?: {
+    hash?: boolean | undefined;
+}) => string;

package/dist/types/helpers/matchPath.d.ts

@@ -1,4 +1,4 @@
-import type { Path, ParseOptions, TokensToRegexpOptions, RegexpToFunctionOptions, MatchFunction } from 'path-to-regexp';
-export { Path };
-/** Create a match function from a path pattern that checks if a URLs matches it. */
-export declare const matchPath: <P extends object = object>(path: Path, options?: ParseOptions & TokensToRegexpOptions & RegexpToFunctionOptions) => MatchFunction<P>;
+import type { Path, ParseOptions, TokensToRegexpOptions, RegexpToFunctionOptions, MatchFunction } from 'path-to-regexp';
+export { Path };
+/** Create a match function from a path pattern that checks if a URLs matches it. */
+export declare const matchPath: <P extends object = object>(path: Path, options?: ParseOptions & TokensToRegexpOptions & RegexpToFunctionOptions) => MatchFunction<P>;

package/dist/types/helpers/updateHistoryRecord.d.ts

@@ -1,2 +1,2 @@
-/** Update the current history record with a custom swup identifier. */
-export declare const updateHistoryRecord: (url?: string | null, customData?: Record<string, unknown>) => void;
+/** Update the current history record with a custom swup identifier. */
+export declare const updateHistoryRecord: (url?: string | null, customData?: Record<string, unknown>) => void;

package/dist/types/helpers.d.ts

@@ -1,7 +1,7 @@
-export { classify } from './helpers/classify.js';
-export { createHistoryRecord } from './helpers/createHistoryRecord.js';
-export { updateHistoryRecord } from './helpers/updateHistoryRecord.js';
-export { delegateEvent } from './helpers/delegateEvent.js';
-export { getCurrentUrl } from './helpers/getCurrentUrl.js';
-export { Location } from './helpers/Location.js';
-export { matchPath } from './helpers/matchPath.js';
+export { classify } from './helpers/classify.js';
+export { createHistoryRecord } from './helpers/createHistoryRecord.js';
+export { updateHistoryRecord } from './helpers/updateHistoryRecord.js';
+export { delegateEvent } from './helpers/delegateEvent.js';
+export { getCurrentUrl } from './helpers/getCurrentUrl.js';
+export { Location } from './helpers/Location.js';
+export { matchPath } from './helpers/matchPath.js';

package/dist/types/index.d.ts

@@ -1,14 +1,14 @@
-import type { Path } from 'path-to-regexp';
-import type { DelegateEventUnsubscribe } from './helpers/delegateEvent.js';
-import type { DelegateEvent, DelegateEventHandler } from 'delegate-it';
-import Swup from './Swup.js';
-import type { Options } from './Swup.js';
-import type { CacheData } from './modules/Cache.js';
-import type { PageData } from './modules/fetchPage.js';
-import type { Visit, VisitFrom, VisitTo, VisitAnimation, VisitScroll, VisitHistory } from './modules/Visit.js';
-import type { HookArguments, HookDefinitions, HookName, HookOptions, HookUnregister, Handler } from './modules/Hooks.js';
-import type { Plugin } from './modules/plugins.js';
-export default Swup;
-export * from './helpers.js';
-export * from './utils.js';
-export type { Swup, Options, Plugin, CacheData, PageData, Visit, VisitFrom, VisitTo, VisitAnimation, VisitScroll, VisitHistory, HookArguments, HookDefinitions, HookName, HookOptions, HookUnregister, Handler, Path, DelegateEvent, DelegateEventHandler, DelegateEventUnsubscribe };
+import type { Path } from 'path-to-regexp';
+import type { DelegateEventUnsubscribe } from './helpers/delegateEvent.js';
+import type { DelegateEvent, DelegateEventHandler } from 'delegate-it';
+import Swup from './Swup.js';
+import type { Options } from './Swup.js';
+import type { CacheData } from './modules/Cache.js';
+import type { PageData } from './modules/fetchPage.js';
+import type { Visit, VisitFrom, VisitTo, VisitAnimation, VisitScroll, VisitHistory } from './modules/Visit.js';
+import type { HookArguments, HookDefinitions, HookName, HookOptions, HookUnregister, Handler } from './modules/Hooks.js';
+import type { Plugin } from './modules/plugins.js';
+export default Swup;
+export * from './helpers.js';
+export * from './utils.js';
+export type { Swup, Options, Plugin, CacheData, PageData, Visit, VisitFrom, VisitTo, VisitAnimation, VisitScroll, VisitHistory, HookArguments, HookDefinitions, HookName, HookOptions, HookUnregister, Handler, Path, DelegateEvent, DelegateEventHandler, DelegateEventUnsubscribe };

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

@@ -1,34 +1,34 @@
-import Swup from '../Swup.js';
-import { PageData } from './fetchPage.js';
-export interface CacheData extends PageData {
-}
-/**
- * In-memory page cache.
- */
-export declare class Cache {
-    /** Swup instance this cache belongs to */
-    protected swup: Swup;
-    /** Cached pages, indexed by URL */
-    protected pages: Map<string, CacheData>;
-    constructor(swup: Swup);
-    /** Number of cached pages in memory. */
-    get size(): number;
-    /** All cached pages. */
-    get all(): Map<any, any>;
-    /** Check if the given URL has been cached. */
-    has(url: string): boolean;
-    /** Return a shallow copy of the cached page object if available. */
-    get(url: string): CacheData | undefined;
-    /** Create a cache record for the specified URL. */
-    set(url: string, page: CacheData): void;
-    /** Update a cache record, overwriting or adding custom data. */
-    update(url: string, payload: Record<string, any>): void;
-    /** Delete a cache record. */
-    delete(url: string): void;
-    /** Empty the cache. */
-    clear(): void;
-    /** Remove all cache entries that return true for a given predicate function.  */
-    prune(predicate: (url: string, page: CacheData) => boolean): void;
-    /** Resolve URLs by making them local and letting swup resolve them. */
-    protected resolve(urlToResolve: string): string;
-}
+import Swup from '../Swup.js';
+import { PageData } from './fetchPage.js';
+export interface CacheData extends PageData {
+}
+/**
+ * In-memory page cache.
+ */
+export declare class Cache {
+    /** Swup instance this cache belongs to */
+    protected swup: Swup;
+    /** Cached pages, indexed by URL */
+    protected pages: Map<string, CacheData>;
+    constructor(swup: Swup);
+    /** Number of cached pages in memory. */
+    get size(): number;
+    /** All cached pages. */
+    get all(): Map<any, any>;
+    /** Check if the given URL has been cached. */
+    has(url: string): boolean;
+    /** Return a shallow copy of the cached page object if available. */
+    get(url: string): CacheData | undefined;
+    /** Create a cache record for the specified URL. */
+    set(url: string, page: CacheData): void;
+    /** Update a cache record, overwriting or adding custom data. */
+    update(url: string, payload: object): void;
+    /** Delete a cache record. */
+    delete(url: string): void;
+    /** Empty the cache. */
+    clear(): void;
+    /** Remove all cache entries that return true for a given predicate function.  */
+    prune(predicate: (url: string, page: CacheData) => boolean): void;
+    /** Resolve URLs by making them local and letting swup resolve them. */
+    protected resolve(urlToResolve: string): string;
+}

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

@@ -1,13 +1,13 @@
-import Swup from '../Swup.js';
-export declare class Classes {
-    protected swup: Swup;
-    protected swupClasses: string[];
-    constructor(swup: Swup);
-    protected get selectors(): string[];
-    protected get selector(): string;
-    protected get targets(): HTMLElement[];
-    add(...classes: string[]): void;
-    remove(...classes: string[]): void;
-    clear(): void;
-    protected isSwupClass(className: string): boolean;
-}
+import Swup from '../Swup.js';
+export declare class Classes {
+    protected swup: Swup;
+    protected swupClasses: string[];
+    constructor(swup: Swup);
+    protected get selectors(): string[];
+    protected get selector(): string;
+    protected get targets(): HTMLElement[];
+    add(...classes: string[]): void;
+    remove(...classes: string[]): void;
+    clear(): void;
+    protected isSwupClass(className: string): boolean;
+}