Merge pull request #2 from StatelessStudio/v1.0.1

V1.0.1

Author: DrewImm

package-lock.json

@@ -1,6 +1,6 @@
 {
 	"name": "api-machine",
-	"version": "1.0.0",
+	"version": "1.0.1",
 	"description": "api-machine",
 	"private": "true",
 	"typescript-template": {
@@ -22,7 +22,7 @@
 		"publish": "npm run script -- publish"
 	},
 	"dependencies": {
-		"auto-oas": "^1.2.0",
+		"auto-oas": "^1.2.1",
 		"cors": "^2.8.5",
 		"express": "^5.1.0",
 		"swagger-ui-express": "^5.0.1",

package.json

@@ -5,6 +5,7 @@ import { HttpErrorOptions } from '../error-options';
  * All HTTP errors extend from this class
  */
 export abstract class HTTPError extends Error {
+	public isApiMachineError = true;
 	public readonly options: HttpErrorOptions = {};
 	public readonly timestamp = new Date().toISOString();
 

src/error/http-errors/http-error.ts

@@ -59,11 +59,11 @@ export class OasRestServerConverter {
 
 	public async convertRouter(router: BaseApiRouter) {
 		for (const route of router.registeredRoutes) {
-			if (route instanceof BaseApiEndpoint) {
-				await this.convertEndpoint(route);
+			if (route.routeType === 'endpoint') {
+				await this.convertEndpoint(route as BaseApiEndpoint);
 			}
-			else if (route instanceof BaseApiRouter) {
-				await this.convertRouter(route);
+			else if (route.routeType === 'router') {
+				await this.convertRouter(route as BaseApiRouter);
 			}
 		}
 	}

src/oas/oas-rest-server-converter.ts

@@ -6,6 +6,7 @@ export abstract class BaseApiRoute {
 	public fullPath: string;
 	public name: string;
 	public description?: string;
+	public routeType: 'router' | 'endpoint';
 
 	/**
 	 * Optional array of Express middleware to apply

src/router/base.ts

@@ -27,6 +27,7 @@ export enum EndpointMethod {
 }
 
 export abstract class BaseApiEndpoint extends BaseApiRoute {
+	override routeType = 'endpoint' as const;
 	override path = '';
 	public tag?: string;
 	public method: EndpointMethod = EndpointMethod.GET;

src/router/endpoint.ts

@@ -3,6 +3,7 @@ import { ApiRoute, BaseApiRoute } from './base';
 import { BaseApiEndpoint, EndpointMethod } from './endpoint';
 
 export abstract class BaseApiRouter extends BaseApiRoute {
+	override routeType = 'router' as const;
 	protected router: ExpressRouter;
 
 	public registeredRoutes: BaseApiRoute[] = [];
@@ -45,23 +46,25 @@ export abstract class BaseApiRouter extends BaseApiRoute {
 			// Set parent relationship for authentication cascading
 			instance.parentRoute = this;
 
-			if (instance instanceof BaseApiEndpoint) {
-				instance.tag = tag;
+			if (instance.routeType === 'endpoint') {
+				(instance as BaseApiEndpoint).tag = tag;
 			}
 
 			await instance.register(this.router, this.fullPath);
 
 			this.registeredRoutes.push(instance);
 
 			// Track endpoint methods for 405 handling
-			if (instance instanceof BaseApiEndpoint) {
+			if (instance.routeType === 'endpoint') {
 				const path = instance.path;
 
 				if (!pathMethods.has(path)) {
 					pathMethods.set(path, new Set());
 				}
 
-				pathMethods.get(path)!.add(instance.method);
+				pathMethods
+					.get(path)!
+					.add((instance as BaseApiEndpoint).method);
 			}
 		}
 

src/router/router.ts

@@ -174,15 +174,17 @@ export abstract class RestServer {
 				next: express.NextFunction
 			) => {
 				// Handle HTTPError instances
-				if (error instanceof HTTPError) {
+				if ((error as HTTPError).isApiMachineError) {
 					// Set custom headers if provided
-					Object.entries(error.headers).forEach(([key, value]) => {
-						response.setHeader(key, value);
-					});
+					Object.entries((error as HTTPError).headers).forEach(
+						([key, value]) => {
+							response.setHeader(key, value);
+						}
+					);
 
 					return response
-						.status(error.getStatusCode())
-						.json(error.getResponseJson());
+						.status((error as HTTPError).getStatusCode())
+						.json((error as HTTPError).getResponseJson());
 				}
 
 				if (