@prosopo/api-express-router 3.2.0 → 3.2.2

package/src/tests/unit/errorHandler.unit.test.ts

@@ -1,190 +0,0 @@
-// Copyright 2021-2026 Prosopo (UK) Ltd.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-import { ProsopoApiError, ProsopoEnvError } from "@prosopo/common";
-import { loadI18next } from "@prosopo/locale";
-import type { NextFunction, Request, Response } from "express";
-import { describe, expect, it, vi } from "vitest";
-import { ZodError } from "zod";
-import { handleErrors } from "../../errorHandler.js";
-
-describe("handleErrors", async () => {
-	const i18n = await loadI18next(true);
-	await i18n.changeLanguage("en");
-
-	it("should handle ProsopoApiError", async () => {
-		const mockRequest = { i18n } as unknown as Request;
-		const mockResponse = {
-			writeHead: vi.fn().mockReturnThis(),
-			set: vi.fn().mockReturnThis(),
-			status: vi.fn().mockReturnThis(),
-			send: vi.fn(),
-			end: vi.fn(),
-		} as unknown as Response;
-		const mockNext = vi.fn() as unknown as NextFunction;
-
-		const error = new ProsopoApiError("CONTRACT.INVALID_DATA_FORMAT", {
-			context: { code: 400 },
-			i18n,
-		});
-		console.log(error);
-
-		handleErrors(error, mockRequest, mockResponse, mockNext);
-
-		expect(mockResponse.set).toHaveBeenCalledWith(
-			"content-type",
-			"application/json",
-		);
-		expect(mockResponse.send).toHaveBeenCalledWith({
-			error: {
-				code: 400,
-				key: "CONTRACT.INVALID_DATA_FORMAT",
-				message: "Invalid data format",
-			},
-		});
-		expect(mockResponse.status).toHaveBeenCalledWith(400);
-		expect(mockResponse.end).toHaveBeenCalled();
-	});
-
-	it("should not return SyntaxError", async () => {
-		const mockRequest = { i18n } as unknown as Request;
-		const mockResponse = {
-			writeHead: vi.fn().mockReturnThis(),
-			set: vi.fn().mockReturnThis(),
-			status: vi.fn().mockReturnThis(),
-			send: vi.fn(),
-			end: vi.fn(),
-		} as unknown as Response;
-		const mockNext = vi.fn() as unknown as NextFunction;
-
-		const message = "Unknown API error";
-		const error = new SyntaxError(message);
-
-		handleErrors(error, mockRequest, mockResponse, mockNext);
-
-		expect(mockResponse.set).toHaveBeenCalledWith(
-			"content-type",
-			"application/json",
-		);
-		expect(mockResponse.status).toHaveBeenCalledWith(400);
-		expect(mockResponse.send).toHaveBeenCalledWith({
-			error: {
-				message,
-				key: "API.UNKNOWN",
-				code: 400,
-			},
-		});
-		expect(mockResponse.end).toHaveBeenCalled();
-	});
-
-	it("should handle ZodError", () => {
-		const mockRequest = { i18n } as unknown as Request;
-		const mockResponse = {
-			writeHead: vi.fn().mockReturnThis(),
-			set: vi.fn().mockReturnThis(),
-			status: vi.fn().mockReturnThis(),
-			send: vi.fn(),
-			end: vi.fn(),
-		} as unknown as Response;
-		const mockNext = vi.fn() as unknown as NextFunction;
-
-		const zodError = {
-			code: "custom" as const,
-			message: "Invalid input",
-			path: ["some", "variable"],
-		};
-		const error = new ZodError([zodError]);
-
-		handleErrors(error, mockRequest, mockResponse, mockNext);
-
-		expect(mockResponse.set).toHaveBeenCalledWith(
-			"content-type",
-			"application/json",
-		);
-		expect(mockResponse.status).toHaveBeenCalledWith(400);
-		expect(mockResponse.send).toHaveBeenCalledWith({
-			error: { code: 400, key: "API.INVALID_BODY", message: [zodError] },
-		});
-		expect(mockResponse.end).toHaveBeenCalled();
-	});
-
-	it("should unwrap nested ProsopoBaseError", async () => {
-		const mockRequest = { i18n } as unknown as Request;
-		const mockResponse = {
-			writeHead: vi.fn().mockReturnThis(),
-			set: vi.fn().mockReturnThis(),
-			status: vi.fn().mockReturnThis(),
-			send: vi.fn(),
-			end: vi.fn(),
-		} as unknown as Response;
-		const mockNext = vi.fn() as unknown as NextFunction;
-
-		const envError = new ProsopoEnvError("GENERAL.ENVIRONMENT_NOT_READY", {
-			i18n,
-		});
-		const apiError = new ProsopoApiError(envError);
-
-		handleErrors(apiError, mockRequest, mockResponse, mockNext);
-
-		expect(mockResponse.set).toHaveBeenCalledWith(
-			"content-type",
-			"application/json",
-		);
-		expect(mockResponse.status).toHaveBeenCalledWith(500);
-		expect(mockResponse.send).toHaveBeenCalledWith({
-			error: {
-				code: 500,
-				key: "GENERAL.ENVIRONMENT_NOT_READY",
-				message: "Environment not ready",
-			},
-		});
-		expect(mockResponse.end).toHaveBeenCalled();
-	});
-
-	it("should unwrap nested ProsopoBaseErrors but not an Error that is nested inside them", async () => {
-		const mockRequest = { i18n } as unknown as Request;
-		const mockResponse = {
-			writeHead: vi.fn().mockReturnThis(),
-			set: vi.fn().mockReturnThis(),
-			status: vi.fn().mockReturnThis(),
-			send: vi.fn(),
-			end: vi.fn(),
-		} as unknown as Response;
-		const mockNext = vi.fn() as unknown as NextFunction;
-		const code = 400;
-		const key = "API.UNKNOWN";
-
-		const error = new Error("Some error");
-		const apiError = new ProsopoApiError(key, {
-			context: { code, error },
-			i18n,
-		});
-
-		handleErrors(apiError, mockRequest, mockResponse, mockNext);
-
-		expect(mockResponse.set).toHaveBeenCalledWith(
-			"content-type",
-			"application/json",
-		);
-		expect(mockResponse.status).toHaveBeenCalledWith(code);
-		expect(mockResponse.send).toHaveBeenCalledWith({
-			error: {
-				code,
-				key,
-				message: "Unknown API error",
-			},
-		});
-		expect(mockResponse.end).toHaveBeenCalled();
-	});
-});

package/src/tests/unit/index.unit.test.ts

@@ -1,95 +0,0 @@
-// Copyright 2021-2026 Prosopo (UK) Ltd.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-import type { ApiRoutes, ApiRoutesProvider } from "@prosopo/api-route";
-import { LogLevel } from "@prosopo/logger";
-import type { NextFunction, Request, Response } from "express";
-import { describe, expect, test, vi } from "vitest";
-import {
-	apiExpressRouterFactory,
-	authMiddleware,
-	createApiExpressDefaultEndpointAdapter,
-	handleErrors,
-	requestLoggerMiddleware,
-} from "../../index.js";
-
-/**
- * The barrel is what every consuming package imports, so the shape of it is
- * part of the contract — a missing re-export or a changed default breaks
- * callers without touching any of the implementations.
- */
-
-describe("createApiExpressDefaultEndpointAdapter", () => {
-	test("builds an adapter exposing handleRequest", () => {
-		const adapter = createApiExpressDefaultEndpointAdapter(LogLevel.enum.info);
-		expect(typeof adapter.handleRequest).toBe("function");
-	});
-
-	test("builds a fresh adapter per call", () => {
-		expect(createApiExpressDefaultEndpointAdapter(LogLevel.enum.info)).not.toBe(
-			createApiExpressDefaultEndpointAdapter(LogLevel.enum.info),
-		);
-	});
-
-	test("defaults the error status code so callers may omit it", () => {
-		expect(() =>
-			createApiExpressDefaultEndpointAdapter(LogLevel.enum.debug),
-		).not.toThrow();
-	});
-
-	test("accepts an explicit error status code", () => {
-		expect(() =>
-			createApiExpressDefaultEndpointAdapter(LogLevel.enum.debug, 503),
-		).not.toThrow();
-	});
-});
-
-describe("apiExpressRouterFactory", () => {
-	test("is exported as a single shared instance", () => {
-		// It holds no per-router state, so one instance is enough — but callers
-		// import the value rather than the class, so it must stay a singleton.
-		expect(typeof apiExpressRouterFactory.createRouter).toBe("function");
-	});
-
-	test("builds a router from a provider", () => {
-		const provider: ApiRoutesProvider = {
-			getRoutes: (): ApiRoutes => ({}),
-		};
-		const router = apiExpressRouterFactory.createRouter(provider, {
-			handleRequest: vi.fn<
-				(
-					endpoint: never,
-					request: Request,
-					response: Response,
-					next: NextFunction,
-				) => Promise<void>
-			>(async () => undefined),
-		});
-		expect(typeof router).toBe("function");
-	});
-});
-
-describe("the re-exported middleware", () => {
-	test("exposes the error handler", () => {
-		expect(typeof handleErrors).toBe("function");
-	});
-
-	test("exposes the auth middleware", () => {
-		expect(typeof authMiddleware).toBe("function");
-	});
-
-	test("exposes the request logger middleware", () => {
-		expect(typeof requestLoggerMiddleware).toBe("function");
-	});
-});