Refactor routeSetup to use args object for better flexibility

Co-authored-by: nielslyngsoe <[email protected]>

Author: Copilot

src/Umbraco.Web.UI.Client/src/packages/core/router/modal-registration/modal-route-registration.controller.ts

@@ -2,7 +2,7 @@ import type { IRouterSlot, Params } from '../router-slot/index.js';
 import { UMB_ROUTE_PATH_ADDENDUM_CONTEXT } from '../contexts/route-path-addendum.context-token.js';
 import { UMB_ROUTE_CONTEXT } from '../route/route.context-token.js';
 import { encodeFolderName } from '../encode-folder-name.function.js';
-import type { UmbModalRouteRegistration } from './modal-route-registration.interface.js';
+import type { UmbModalRouteRegistration, UmbModalRouteSetupArgs } from './modal-route-registration.interface.js';
 import type {
 	UmbModalConfig,
 	UmbModalContext,
@@ -329,28 +329,22 @@ export class UmbModalRouteRegistrationController<
 		this.#modalContext = undefined;
 	};
 
-	async routeSetup(
-		router: IRouterSlot,
-		modalManagerContext: UmbModalManagerContext,
-		params: Params,
-		routeHandler: UmbModalRouteHandler,
-		routeContextToken: UmbContextToken<any>,
-	) {
+	async routeSetup(args: UmbModalRouteSetupArgs) {
 		// If already open, don't do anything:
 		if (this.active) return;
 
-		const modalData = this.#onSetupCallback ? await this.#onSetupCallback(params) : undefined;
+		const modalData = this.#onSetupCallback ? await this.#onSetupCallback(args.params) : undefined;
 		if (modalData !== false) {
-			const args = {
+			const modalArgs = {
 				modal: {},
 				...modalData,
-				router,
-				routeHandler,
-				routeContextToken,
+				router: args.router,
+				routeHandler: args.routeHandler,
+				routeContextToken: args.routeContextToken,
 			} as UmbModalContextClassArgs<UmbModalToken<UmbModalTokenData, UmbModalTokenValue>>;
-			args.modal!.key = this.#key;
+			modalArgs.modal!.key = this.#key;
 
-			this.#modalContext = modalManagerContext.open(this, this.#modalAlias, args);
+			this.#modalContext = args.modalManagerContext.open(this, this.#modalAlias, modalArgs);
 			this.#modalContext.onSubmit().then(this.#onSubmit, this.#onReject);
 			return this.#modalContext;
 		}

src/Umbraco.Web.UI.Client/src/packages/core/router/modal-registration/modal-route-registration.interface.ts

@@ -8,6 +8,14 @@ import type {
 } from '@umbraco-cms/backoffice/modal';
 import type { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
 
+export type UmbModalRouteSetupArgs = {
+	router: IRouterSlot;
+	modalManagerContext: UmbModalManagerContext;
+	params: Params;
+	routeHandler: UmbModalRouteHandler;
+	routeContextToken: UmbContextToken<any>;
+};
+
 export interface UmbModalRouteRegistration<
 	UmbModalTokenData extends { [key: string]: any } = { [key: string]: any },
 	UmbModalTokenValue = any,
@@ -21,11 +29,7 @@ export interface UmbModalRouteRegistration<
 	open(params: { [key: string]: string | number }, prepend?: string): void;
 
 	routeSetup(
-		router: IRouterSlot,
-		modalManagerContext: UmbModalManagerContext,
-		params: Params,
-		routeHandler: UmbModalRouteHandler,
-		routeContextToken: UmbContextToken<any>,
+		args: UmbModalRouteSetupArgs,
 	): Promise<undefined | UmbModalContext<UmbModalTokenData, UmbModalTokenValue>>;
 
 	// eslint-disable-next-line @typescript-eslint/naming-convention

src/Umbraco.Web.UI.Client/src/packages/core/router/route/route.context.ts

@@ -69,13 +69,13 @@ export class UmbRouteContext extends UmbContextBase {
 			component: EmptyDiv,
 			setup: async (component, info) => {
 				if (!this.#modalContext) return;
-				const modalContext = await modalRegistration.routeSetup(
-					this.#modalRouter,
-					this.#modalContext,
-					info.match.params,
-					this.#routeHandler,
-					UMB_ROUTE_CONTEXT,
-				);
+				const modalContext = await modalRegistration.routeSetup({
+					router: this.#modalRouter,
+					modalManagerContext: this.#modalContext,
+					params: info.match.params,
+					routeHandler: this.#routeHandler,
+					routeContextToken: UMB_ROUTE_CONTEXT,
+				});
 				if (modalContext) {
 					modalContext._internal_setCurrentModalPath(info.match.fragments.consumed);
 				}