Merge pull request #53 from swup/chore/refactor-exports

chore: refactor exports

Author: hirasso

src/SwupFragmentPlugin.ts

@@ -1,25 +1,16 @@
 import PluginBase from '@swup/plugin';
 import ParsedRule from './inc/ParsedRule.js';
 import Logger from './inc/Logger.js';
-import { handlePageView, cleanupFragmentElements, getFragmentVisit } from './inc/functions.js';
-import type { Route, Options, FragmentVisit } from './inc/types.js';
-
+import {
+	handlePageView,
+	cleanupFragmentElements,
+	getFirstMatchingRule,
+	getContainersForVisit
+} from './inc/functions.js';
+import type { Options, Route, FragmentVisit } from './inc/defs.js';
 import * as handlers from './inc/handlers.js';
-
 import { __DEV__ } from './inc/env.js';
 
-declare module 'swup' {
-	export interface Swup {
-		getFragmentVisit?: (route: Route) => FragmentVisit | undefined;
-	}
-	export interface Visit {
-		fragmentVisit?: FragmentVisit;
-	}
-	export interface CacheData {
-		fragmentHtml?: string;
-	}
-}
-
 type RequireKeys<T, K extends keyof T> = Partial<T> & Pick<T, K>;
 type InitOptions = RequireKeys<Options, 'rules'>;
 
@@ -74,7 +65,7 @@ export default class SwupFragmentPlugin extends PluginBase {
 		this.on('content:replace', handlers.onContentReplace);
 		this.on('visit:end', handlers.onVisitEnd);
 
-		swup.getFragmentVisit = getFragmentVisit.bind(this);
+		swup.getFragmentVisit = this.getFragmentVisit.bind(this);
 
 		if (__DEV__) {
 			this.logger?.warnIf(
@@ -94,4 +85,31 @@ export default class SwupFragmentPlugin extends PluginBase {
 		this.swup.getFragmentVisit = undefined;
 		cleanupFragmentElements();
 	}
+
+	/**
+	 * Get the fragment visit object for a given route
+	 */
+	getFragmentVisit(route: Route): FragmentVisit | undefined {
+		const rule = getFirstMatchingRule(route, this.rules);
+
+		// Bail early if no rule matched
+		if (!rule) return;
+
+		// Get containers that should be replaced for this visit
+		const containers = getContainersForVisit(route, rule.containers, this.logger);
+		// Bail early if there are no containers to be replaced for this visit
+		if (!containers.length) return;
+
+		// Pick properties from the current rule that should be projected into the fragmentVisit object
+		const { name, scroll, focus } = rule;
+
+		const fragmentVisit: FragmentVisit = {
+			containers,
+			name,
+			scroll,
+			focus
+		};
+
+		return fragmentVisit;
+	}
 }

src/inc/ParsedRule.ts

@@ -1,6 +1,6 @@
 import { matchPath, classify, Location } from 'swup';
 import type { Path } from 'swup';
-import type { Route } from './types.js';
+import type { Route } from './defs.js';
 import { dedupe } from './functions.js';
 import Logger, { highlight } from './Logger.js';
 import { __DEV__ } from './env.js';

src/inc/types.d.ts src/inc/defs.ts

@@ -1,7 +1,7 @@
 import { Location } from 'swup';
 import type { Visit, VisitScroll } from 'swup';
 import type { default as FragmentPlugin } from '../SwupFragmentPlugin.js';
-import type { Route, FragmentVisit, FragmentElement } from './types.js';
+import type { Route, FragmentVisit, FragmentElement } from './defs.js';
 import type ParsedRule from './ParsedRule.js';
 import Logger, { highlight } from './Logger.js';
 
@@ -329,37 +329,6 @@ export function dedupe<T>(arr: Array<T>): Array<T> {
 	return [...new Set<T>(arr)];
 }
 
-/**
- * Get the fragment visit object for a given route
- */
-export function getFragmentVisit(
-	this: FragmentPlugin,
-	route: Route,
-	logger?: Logger
-): FragmentVisit | undefined {
-	const rule = getFirstMatchingRule(route, this.rules);
-
-	// Bail early if no rule matched
-	if (!rule) return;
-
-	// Get containers that should be replaced for this visit
-	const containers = getContainersForVisit(route, rule.containers, logger);
-	// Bail early if there are no containers to be replaced for this visit
-	if (!containers.length) return;
-
-	// Pick properties from the current rule that should be projected into the fragmentVisit object
-	const { name, scroll, focus } = rule;
-
-	const visit: FragmentVisit = {
-		containers,
-		name,
-		scroll,
-		focus
-	};
-
-	return visit;
-}
-
 /**
  * Adjusts visit.scroll based on given fragment visit
  */

src/inc/functions.ts

@@ -10,7 +10,6 @@ import {
 	getFirstMatchingRule,
 	cacheForeignFragmentElements,
 	shouldSkipAnimation,
-	getFragmentVisit,
 	adjustVisitScroll
 } from './functions.js';
 
@@ -36,7 +35,7 @@ export const onVisitStart: Handler<'visit:start'> = async function (this: Fragme
 	const route = getRoute(visit);
 	if (!route) return;
 
-	const fragmentVisit = getFragmentVisit.call(this, route, this.logger);
+	const fragmentVisit = this.getFragmentVisit(route);
 
 	/**
 	 * Bail early if the current route doesn't match

src/inc/handlers.ts

@@ -1,3 +1,16 @@
 import FragmentPlugin from './SwupFragmentPlugin.js';
 export default FragmentPlugin;
-export type { Options, Rule, FragmentElement } from './inc/types.js';
+import type { FragmentVisit } from './inc/defs.js';
+export type { Options, Rule, FragmentElement, FragmentVisit } from './inc/defs.js';
+
+declare module 'swup' {
+	export interface Swup {
+		getFragmentVisit?: FragmentPlugin['getFragmentVisit'];
+	}
+	export interface Visit {
+		fragmentVisit?: FragmentVisit;
+	}
+	export interface CacheData {
+		fragmentHtml?: string;
+	}
+}

src/index.ts

@@ -12,7 +12,6 @@
     "moduleDetection": "force",
     /* Strictness */
     "strict": true,
-    // "noUncheckedIndexedAccess": true,
     /* If transpiling with TypeScript: */
     "moduleResolution": "NodeNext",
     "module": "NodeNext",