refactor: Move HttpHandler types to same file

joachimvh · joachimvh · commit 06f203160915 · 2025-04-14T13:38:28.000+02:00
diff --git a/packages/uma/src/index.ts b/packages/uma/src/index.ts
@@ -64,10 +64,6 @@ export * from './views/ScopeDescription';
 // HTTP
 export * from './util/http/identifier/BaseTargetExtractor';
 export * from './util/http/models/HttpHandler';
-export * from './util/http/models/HttpHandlerContext';
-export * from './util/http/models/HttpHandlerController';
-export * from './util/http/models/HttpHandlerRequest';
-export * from './util/http/models/HttpHandlerResponse';
 export * from './util/http/models/HttpHandlerRoute';
 export * from './util/http/server/ErrorHandler';
 export * from './util/http/server/NodeHttpRequestResponseHandler';
diff --git a/packages/uma/src/routes/Config.ts b/packages/uma/src/routes/Config.ts
@@ -1,9 +1,7 @@
 import { ASYMMETRIC_CRYPTOGRAPHIC_ALGORITHM }
   from '@solid/access-token-verifier/dist/constant/ASYMMETRIC_CRYPTOGRAPHIC_ALGORITHM';
 import { getLoggerFor } from '@solid/community-server';
-import { HttpHandler } from '../util/http/models/HttpHandler';
-import { HttpHandlerContext } from '../util/http/models/HttpHandlerContext';
-import { HttpHandlerResponse } from '../util/http/models/HttpHandlerResponse';
+import { HttpHandler, HttpHandlerContext, HttpHandlerResponse } from '../util/http/models/HttpHandler';
 
 // eslint-disable no-unused-vars
 export enum ResponseType {
diff --git a/packages/uma/src/routes/Contract.ts b/packages/uma/src/routes/Contract.ts
@@ -1,8 +1,6 @@
 import { getLoggerFor } from '@solid/community-server';
 import { getOperationLogger } from '../logging/OperationLogger';
-import { HttpHandler } from '../util/http/models/HttpHandler';
-import { HttpHandlerContext } from '../util/http/models/HttpHandlerContext';
-import { HttpHandlerResponse } from '../util/http/models/HttpHandlerResponse';
+import { HttpHandler, HttpHandlerContext, HttpHandlerResponse } from '../util/http/models/HttpHandler';
 
 /**
  * An HttpHandler used for returning the logs
diff --git a/packages/uma/src/routes/Default.ts b/packages/uma/src/routes/Default.ts
@@ -1,6 +1,4 @@
-import {HttpHandler} from '../util/http/models/HttpHandler';
-import {HttpHandlerContext} from '../util/http/models/HttpHandlerContext';
-import {HttpHandlerResponse} from '../util/http/models/HttpHandlerResponse';
+import { HttpHandler, HttpHandlerContext, HttpHandlerResponse } from '../util/http/models/HttpHandler';
 
 /**
  * Default route handler
diff --git a/packages/uma/src/routes/Introspection.ts b/packages/uma/src/routes/Introspection.ts
@@ -1,6 +1,5 @@
-import { HttpHandlerContext } from '../util/http/models/HttpHandlerContext';
-import { HttpHandler } from '../util/http/models/HttpHandler';
-import { HttpHandlerResponse } from '../util/http/models/HttpHandlerResponse';
+
+import { HttpHandler, HttpHandlerContext, HttpHandlerResponse } from '../util/http/models/HttpHandler';
 import { AccessToken } from '../tokens/AccessToken';
 import { JwtTokenFactory } from '../tokens/JwtTokenFactory';
 import { SerializedToken } from '../tokens/TokenFactory';
diff --git a/packages/uma/src/routes/Jwks.ts b/packages/uma/src/routes/Jwks.ts
@@ -1,6 +1,4 @@
-import { HttpHandler } from '../util/http/models/HttpHandler';
-import { HttpHandlerContext } from '../util/http/models/HttpHandlerContext';
-import { HttpHandlerResponse } from '../util/http/models/HttpHandlerResponse';
+import { HttpHandler, HttpHandlerContext, HttpHandlerResponse } from '../util/http/models/HttpHandler';
 import { getLoggerFor, JwkGenerator } from '@solid/community-server';
 
 /**
diff --git a/packages/uma/src/routes/Log.ts b/packages/uma/src/routes/Log.ts
@@ -1,8 +1,6 @@
 import { getLoggerFor, serializeQuads } from '@solid/community-server';
 import { getOperationLogger } from '../logging/OperationLogger';
-import { HttpHandler } from '../util/http/models/HttpHandler';
-import { HttpHandlerContext } from '../util/http/models/HttpHandlerContext';
-import { HttpHandlerResponse } from '../util/http/models/HttpHandlerResponse';
+import { HttpHandler, HttpHandlerContext, HttpHandlerResponse } from '../util/http/models/HttpHandler';
 
 
 export type LogMessage = {
diff --git a/packages/uma/src/routes/ResourceRegistration.ts b/packages/uma/src/routes/ResourceRegistration.ts
@@ -8,10 +8,12 @@ import {
   UnsupportedMediaTypeHttpError
 } from '@solid/community-server';
 import { randomUUID } from 'node:crypto';
-import {HttpHandler} from '../util/http/models/HttpHandler';
-import {HttpHandlerContext} from '../util/http/models/HttpHandlerContext';
-import {HttpHandlerResponse} from '../util/http/models/HttpHandlerResponse';
-import { HttpHandlerRequest } from '../util/http/models/HttpHandlerRequest';
+import {
+  HttpHandler,
+  HttpHandlerContext,
+  HttpHandlerRequest,
+  HttpHandlerResponse
+} from '../util/http/models/HttpHandler';
 import { ResourceDescription } from '../views/ResourceDescription';
 import { reType } from '../util/ReType';
 import { extractRequestSigner, verifyRequest } from '../util/HttpMessageSignatures';
diff --git a/packages/uma/src/routes/Ticket.ts b/packages/uma/src/routes/Ticket.ts
@@ -8,9 +8,7 @@ import {
   UnsupportedMediaTypeHttpError
 } from '@solid/community-server';
 import { randomUUID } from 'node:crypto';
-import { HttpHandler } from '../util/http/models/HttpHandler';
-import { HttpHandlerContext } from '../util/http/models/HttpHandlerContext';
-import { HttpHandlerResponse } from '../util/http/models/HttpHandlerResponse';
+import { HttpHandler, HttpHandlerContext, HttpHandlerResponse } from '../util/http/models/HttpHandler';
 import { verifyRequest } from '../util/HttpMessageSignatures';
 import { array, reType } from '../util/ReType';
 import { Permission } from '../views/Permission';
diff --git a/packages/uma/src/routes/Token.ts b/packages/uma/src/routes/Token.ts
@@ -4,9 +4,7 @@ import {
   getLoggerFor,
   UnsupportedMediaTypeHttpError
 } from '@solid/community-server';
-import { HttpHandler } from '../util/http/models/HttpHandler';
-import { HttpHandlerContext } from '../util/http/models/HttpHandlerContext';
-import { HttpHandlerResponse } from '../util/http/models/HttpHandlerResponse';
+import { HttpHandler, HttpHandlerContext, HttpHandlerResponse } from '../util/http/models/HttpHandler';
 import { Negotiator } from '../dialog/Negotiator';
 import { DialogInput } from '../dialog/Input';
 import { reType } from '../util/ReType';
diff --git a/packages/uma/src/routes/VC.ts b/packages/uma/src/routes/VC.ts
@@ -1,8 +1,6 @@
 import { getLoggerFor } from '@solid/community-server';
 import { getOperationLogger } from '../logging/OperationLogger';
-import { HttpHandler } from '../util/http/models/HttpHandler';
-import { HttpHandlerContext } from '../util/http/models/HttpHandlerContext';
-import { HttpHandlerResponse } from '../util/http/models/HttpHandlerResponse';
+import { HttpHandler, HttpHandlerContext, HttpHandlerResponse } from '../util/http/models/HttpHandler';
 
 
 /**
diff --git a/packages/uma/src/util/HttpMessageSignatures.ts b/packages/uma/src/util/HttpMessageSignatures.ts
@@ -2,15 +2,15 @@ import { UnauthorizedHttpError, type AlgJwk, BadRequestHttpError, InternalServer
 import { httpbis, type SigningKey, type Request as SignRequest } from 'http-message-signatures';
 import { verifyMessage } from 'http-message-signatures/lib/httpbis';
 import { type SignatureParameters, type VerifierFinder, type VerifyingKey } from 'http-message-signatures/lib/types';
-import type { HttpHandlerRequest } from './http/models/HttpHandlerRequest';
+import { HttpHandlerRequest } from './http/models/HttpHandler';
 import buildGetJwks from 'get-jwks';
 import crypto from 'node:crypto';
 
 const authParserMod = import('@httpland/authorization-parser');
 
 export async function signRequest(
-  url: string, 
-  request: RequestInit & Omit<SignRequest, 'url'>, 
+  url: string,
+  request: RequestInit & Omit<SignRequest, 'url'>,
   jwk: AlgJwk
 ): Promise<RequestInit & SignRequest> {
   const key: SigningKey = {
@@ -52,10 +52,10 @@ export async function verifyRequest(
   signer?: string,
 ): Promise<boolean> {
   signer = signer ?? await extractRequestSigner(request);
-  
+
   if (signer.startsWith('"')) signer = signer.slice(1);
   if (signer.endsWith('"')) signer = signer.slice(0,-1);
-  
+
   const jwks = buildGetJwks();
 
   const keyLookup: VerifierFinder = async (params: SignatureParameters) => {
@@ -67,7 +67,7 @@ export async function verifyRequest(
         alg: alg ?? '',
         kid: keyid ?? '',
       })
-    
+
       if (!alg) throw new BadRequestHttpError('Invalid HTTP message Signature parameters.');
       // if (alg === 'EdDSA') throw new InternalServerError('EdDSA signing is not supported');
       // if (alg === 'ES256K') throw new InternalServerError('ES256K signing is not supported');
@@ -83,7 +83,7 @@ export async function verifyRequest(
           } catch (err) { console.log(err); return null }
         },
       };
-      
+
       return verifier;
 
     } catch (err) {
@@ -111,4 +111,3 @@ const algMap: Record<string, AlgParams> = {
   'RS384': { name: 'RSASSA-PKCS1-v1_5', hash: 'SHA-384' },
   'RS512': { name: 'RSASSA-PKCS1-v1_5', hash: 'SHA-512' },
 }
-
diff --git a/packages/uma/src/util/http/models/HttpHandler.ts b/packages/uma/src/util/http/models/HttpHandler.ts
@@ -1,7 +1,23 @@
 import { AsyncHandler } from '@solid/community-server';
-import { HttpHandlerResponse } from './HttpHandlerResponse';
-import { HttpHandlerContext } from './HttpHandlerContext';
+import { OutgoingHttpHeaders } from 'http';
+
+export interface HttpHandlerContext {
+  request: HttpHandlerRequest;
+}
+
+export interface HttpHandlerRequest<B = unknown> {
+  url: URL;
+  method: string;
+  parameters?: { [key: string]: string };
+  headers: { [key: string]: string };
+  body?: B;
+}
+
+export interface HttpHandlerResponse<B = unknown> {
+  body?: B;
+  headers?: OutgoingHttpHeaders;
+  status: number;
+}
 
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
 export abstract class HttpHandler<C extends HttpHandlerContext = HttpHandlerContext>
   extends AsyncHandler<C, HttpHandlerResponse> { }
diff --git a/packages/uma/src/util/http/models/HttpHandlerContext.ts b/packages/uma/src/util/http/models/HttpHandlerContext.ts
diff --git a/packages/uma/src/util/http/models/HttpHandlerController.ts b/packages/uma/src/util/http/models/HttpHandlerController.ts
diff --git a/packages/uma/src/util/http/models/HttpHandlerRequest.ts b/packages/uma/src/util/http/models/HttpHandlerRequest.ts
diff --git a/packages/uma/src/util/http/models/HttpHandlerResponse.ts b/packages/uma/src/util/http/models/HttpHandlerResponse.ts
diff --git a/packages/uma/src/util/http/models/HttpHandlerRoute.ts b/packages/uma/src/util/http/models/HttpHandlerRoute.ts
@@ -1,5 +1,4 @@
-import { HttpHandler } from './HttpHandler';
-import { HttpHandlerContext } from './HttpHandlerContext';
+import { HttpHandler, HttpHandlerContext } from './HttpHandler';
 
 export abstract class HttpHandlerRoute<C extends HttpHandlerContext = HttpHandlerContext> {
   constructor(
diff --git a/packages/uma/src/util/http/server/ErrorHandler.ts b/packages/uma/src/util/http/server/ErrorHandler.ts
@@ -1,7 +1,5 @@
 import { getLoggerFor } from '@solid/community-server';
-import {HttpHandler} from '../models/HttpHandler';
-import {HttpHandlerContext} from '../models/HttpHandlerContext';
-import {HttpHandlerResponse} from '../models/HttpHandlerResponse';
+import { HttpHandler, HttpHandlerContext, HttpHandlerResponse } from '../models/HttpHandler';
 
 export const statusCodes: { [code: number]: string } = {
   400: 'Bad Request',
diff --git a/packages/uma/src/util/http/server/NodeHttpRequestResponseHandler.ts b/packages/uma/src/util/http/server/NodeHttpRequestResponseHandler.ts
@@ -1,5 +1,5 @@
 import { OutgoingHttpHeader } from 'node:http';
-import { HttpHandler } from '../models/HttpHandler';
+import { HttpHandler, HttpHandlerContext, HttpHandlerRequest, HttpHandlerResponse } from '../models/HttpHandler';
 import {
   BadRequestHttpError,
   getLoggerFor,
@@ -9,9 +9,6 @@ import {
   readableToString,
   TargetExtractor
 } from '@solid/community-server';
-import { HttpHandlerContext } from '../models/HttpHandlerContext';
-import { HttpHandlerRequest } from '../models/HttpHandlerRequest';
-import { HttpHandlerResponse } from '../models/HttpHandlerResponse';
 import { statusCodes } from './ErrorHandler';
 
 
diff --git a/packages/uma/src/util/http/server/RoutedHttpRequestHandler.ts b/packages/uma/src/util/http/server/RoutedHttpRequestHandler.ts
@@ -1,8 +1,6 @@
 import { getLoggerFor } from '@solid/community-server';
 import Template from 'uri-template-lite';
-import { HttpHandler } from '../models/HttpHandler';
-import { HttpHandlerContext } from '../models/HttpHandlerContext';
-import { HttpHandlerResponse } from '../models/HttpHandlerResponse';
+import { HttpHandler, HttpHandlerContext, HttpHandlerResponse } from '../models/HttpHandler';
 import { HttpHandlerRoute } from '../models/HttpHandlerRoute';
 
 /**
