rename the user object to auth

src/server/dispatcher.ts

@@ -220,14 +220,18 @@ export class Dispatcher {
 
   // eslint-disable-next-line sonarjs/cognitive-complexity, max-statements
   public async request({
+    auth,
     body,
     headers = {},
     method,
     path,
     query,
     req,
-    user,
   }: {
+    auth?: {
+      password?: string;
+      username?: string;
+    };
     body: unknown;
     headers: {
       [key: string]: string;
@@ -240,10 +244,6 @@ export class Dispatcher {
     req: {
       path?: string;
     };
-    user?: {
-      password?: string;
-      username?: string;
-    };
   }): Promise<NormalizedCounterfactResponseObject> {
     debug(`request: ${method} ${path}`);
 
@@ -264,8 +264,10 @@ export class Dispatcher {
       path,
       this.parameterTypes(operation?.parameters),
     )({
+      auth,
       body,
       context: this.contextRegistry.find(matchedPath),
+
       headers,
 
       proxy: async (url: string) => {
@@ -301,8 +303,6 @@ export class Dispatcher {
       response: createResponseBuilder(operation ?? { responses: {} }),
 
       tools: new Tools({ headers }),
-
-      user,
     });
 
     if (response === undefined) {

src/server/koa-middleware.ts

@@ -24,7 +24,7 @@ function addCors(ctx: Koa.ExtendableContext, headers?: IncomingHttpHeaders) {
   ctx.set("Access-Control-Allow-Credentials", "true");
 }
 
-function getBasicAuthCredentials(
+function getAuthObject(
   ctx: Koa.ExtendableContext & { user?: { [key: string]: string } },
 ):
   | {
@@ -60,7 +60,7 @@ export function koaMiddleware(
       return await next();
     }
 
-    const user = getBasicAuthCredentials(ctx);
+    const auth = getAuthObject(ctx);
 
     /* @ts-expect-error the body comes from koa-bodyparser, not sure how to fix this */
     const { body, headers, query } = ctx.request;
@@ -84,6 +84,7 @@ export function koaMiddleware(
     }
 
     const response = await dispatcher.request({
+      auth,
       // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
       body,
       /* @ts-expect-error the value of a header can be an array and we don't have a solution for that yet */
@@ -93,7 +94,6 @@ export function koaMiddleware(
       /* @ts-expect-error the value of a querystring item can be an array and we don't have a solution for that yet */
       query,
       req: { path: "", ...ctx.req },
-      user,
     });
 
     /* eslint-disable require-atomic-updates */

test/server/koa-middleware.test.ts

@@ -310,9 +310,9 @@ describe("koa middleware", () => {
     const registry = new Registry();
 
     registry.add("/hello", {
-      GET({ user }: { user?: { password?: string; username?: string } }) {
+      GET({ auth }: { auth?: { password?: string; username?: string } }) {
         return {
-          body: `${user?.username ?? ""} / ${user?.password ?? ""}`,
+          body: `${auth?.username ?? ""} / ${auth?.password ?? ""}`,
         };
       },
     });