tibber-express-utils 3.5.0 → 4.0.0

package/dist/src/HttpResult.d.ts

@@ -1,5 +1,5 @@
-declare type HttpHeaderValue = undefined | string | string[];
-declare type HttpHeaders = {
+type HttpHeaderValue = undefined | string | string[];
+type HttpHeaders = {
     [key: string]: HttpHeaderValue;
 };
 export declare class HttpResult<TPayload = unknown> {

package/dist/src/errors/ProblemDetailsError.d.ts

@@ -1,5 +1,5 @@
 import { HttpError } from './HttpError';
-export declare type ProblemDetailsArgs = {
+export type ProblemDetailsArgs = {
     detail?: string;
     instance?: string;
     statusCode: number;

package/dist/src/errors/ServerError.js

@@ -4,7 +4,7 @@ exports.ServerError = void 0;
 const HttpError_1 = require("./HttpError");
 class ServerError extends HttpError_1.HttpError {
     constructor(message) {
-        super(message, 400);
+        super(message, 500);
     }
 }
 exports.ServerError = ServerError;

package/dist/src/types.d.ts

@@ -4,7 +4,7 @@ import { HttpResult } from './HttpResult';
 /**
  * Params for constructing the jsonRouter.
  */
-export declare type JsonRouterParams<TContext = unknown> = {
+export type JsonRouterParams<TContext = unknown> = {
     contextSelector?: ContextSelector<TContext>;
     expressRouter: Router;
     logger?: Logger;
@@ -13,20 +13,20 @@ export declare type JsonRouterParams<TContext = unknown> = {
  * Configures an express.Router instance as a JsonRouter, adding the 'jsonXXX'
  * api which routes requests through Tibber's jsonMiddleware.
  */
-export declare type JsonRouting<TContext = unknown> = {
+export type JsonRouting<TContext = unknown> = {
     (jsonRouterParams: JsonRouterParams<TContext>): JsonRouter<TContext>;
 };
 /**
  * Where relevant, extracts a context object from the express Request instance.
  */
-export declare type ContextSelector<TContext> = (request: Request) => TContext;
+export type ContextSelector<TContext> = (request: Request) => TContext;
 /**
  * A JsonRouter is an express.Router instance that also provides shorthand HTTP methods
  * using Tibber's jsonMiddleware under the 'jsonXXX' naming convention.
  *
  * Poke changing for feat.
  */
-export declare type JsonRouter<TContext> = Router & {
+export type JsonRouter<TContext> = Router & {
     jsonDelete: JsonRouteMatcher<TContext>;
     jsonGet: JsonRouteMatcher<TContext>;
     jsonPatch: JsonRouteMatcher<TContext>;
@@ -36,7 +36,7 @@ export declare type JsonRouter<TContext> = Router & {
 /**
  * Defines the JsonRequestHandler that is to be used for a specific path.
  */
-export declare type JsonRouteMatcher<TContext> = {
+export type JsonRouteMatcher<TContext> = {
     <TPayload>(path: PathParams, handler: JsonRequestHandler<TContext, TPayload>): JsonRouter<TContext>;
 };
 /**
@@ -48,13 +48,13 @@ export declare type JsonRouteMatcher<TContext> = {
  *
  * It is expected that the handler returns a JsonRequestHandlerResult.
  */
-export declare type JsonRequestHandler<TContext, TPayload> = (req: Request, ctx?: TContext) => JsonRequestHandlerResult<TPayload>;
+export type JsonRequestHandler<TContext, TPayload> = (req: Request, ctx: TContext) => JsonRequestHandlerResult<TPayload>;
 /**
  * The allowable return types of a JsonRequestHandler. A JsonRequestHandler
  * may return undefined, an HTTP status code (number) or an HttpResult
  * encapsulating a TPayload instance.
  */
-export declare type JsonRequestHandlerResult<TPayload> = undefined | HttpResult<TPayload> | TPayload | number;
+export type JsonRequestHandlerResult<TPayload> = undefined | HttpResult<TPayload> | TPayload | number;
 /**
  * The Logger interface whose implementation is to be supplied by the consuming service.
  */
@@ -77,11 +77,11 @@ export interface Logger {
  * An Logger instance, if provided, will receive error messages raised during
  * request handling.
  */
-export declare type JsonMiddleware = {
+export type JsonMiddleware = {
     <TContext, TPayload>(httpStatusCodeSelector: HttpStatusCodeSelector, contextSelector: ContextSelector<TContext>, handler: JsonRequestHandler<TContext, TPayload>, logger?: Logger): (req: Request, res: Response, next: NextFunction) => Promise<Response<TPayload>>;
 };
 /**
  * Defines logic remapping a status code returned from a JsonRequestHandler in a
  * JsonRequestHandlerResult type.
  */
-export declare type HttpStatusCodeSelector = (httpStatusCode: undefined | number | unknown) => number;
+export type HttpStatusCodeSelector = (httpStatusCode: undefined | number | unknown) => number;

package/dist/src/utils/ContextOf.d.ts

@@ -3,4 +3,4 @@ import { ContextSelector } from '../types';
  * Given a concrete ContextSelector function, infers the type of the context
  * that it selects.
  */
-export declare type ContextOf<TContextSelector extends ContextSelector<unknown>> = TContextSelector extends ContextSelector<infer U> ? U : never;
+export type ContextOf<TContextSelector extends ContextSelector<unknown>> = TContextSelector extends ContextSelector<infer U> ? U : never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tibber-express-utils",
-  "version": "3.5.0",
+  "version": "4.0.0",
   "description": "",
   "main": "./dist/src/index.js",
   "scripts": {
@@ -28,25 +28,25 @@
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.1",
     "@semantic-release/git": "^10.0.1",
-    "@types/express": "^4.17.13",
+    "@types/express": "^5.0.0",
     "@types/jest": "^28.1.6",
     "@types/node": "^18.7.2",
     "@types/supertest": "^2.0.12",
-    "commitizen": "^4.2.5",
+    "commitizen": "^4.3.1",
     "conventional-commits": "^1.6.0",
     "cz-conventional-changelog": "^3.3.0",
     "dotenv-cli": "^6.0.0",
     "eslint-plugin-jest": "^26.8.2",
     "eslint-plugin-node": "^11.1.0",
-    "express": "^4.18.1",
+    "express": "^5.1.0",
     "gts": "^4.0.0",
     "husky": "^8.0.1",
     "jest": "^28.1.3",
-    "lint-staged": "^13.0.3",
-    "postcss": "^8.4.16",
-    "semantic-release": "^19.0.3",
-    "sortier": "^1.0.1",
-    "supertest": "^6.2.4",
+    "lint-staged": "^15.5.1",
+    "postcss": "^8.4.38",
+    "semantic-release": "^23.0.8",
+    "sortier": "^2.0.2",
+    "supertest": "^7.0.0",
     "ts-jest": "^28.0.7",
     "typescript": "^4.7.4",
     "yarn-upgrade-all": "^0.7.1"
@@ -54,6 +54,12 @@
   "dependencies": {
     "es6-error": "^4.1.1"
   },
+  "peerDependencies": {
+    "express": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/tibber/tibber-express-utils.git"

package/readme.md

@@ -3,10 +3,15 @@
 
 # Usage
 
+## Requirements
+
+- **Node.js**: 18 or higher
+- **Express**: 5.x (peer dependency)
+
 ## Install
 
 ```
-$ yarn install --save tibber-express-utils
+$ yarn add tibber-express-utils express@5
 ```
 
 ## Usage
@@ -76,6 +81,29 @@ In order to migrate to `3.0.0`:
 1. Update `jsonRouting(express.Router(), contextSelector)` statements to `jsonRouting({contextSelector, expressRouter: express.Router()})` or
    more preferably to `jsonRouting({contextSelector, logger, expressRouter: express.Router()})`).
 
+## Upgrading to 4.0.0
+
+Breaking changes in `4.0.0` include:
+
+ - **Express 5 Support**: This version now supports Express 5.x as a peer dependency.
+ - **Node.js Requirement**: Minimum Node.js version is now 18.0.0 (required by Express 5).
+
+### Migration from 3.x.x to 4.0.0
+
+To migrate to `4.0.0`:
+
+1. **Update Node.js**: Ensure you're running Node.js 18 or higher.
+2. **Update Express**: Install Express 5.x:
+   ```bash
+   yarn add express@5
+   ```
+3. **Update your package**: Update tibber-express-utils to 4.x:
+   ```bash
+   yarn add tibber-express-utils@4
+   ```
+
+**Note**: This library maintains the same API and doesn't use any deprecated Express features, so no code changes should be required in most cases.
+
 # Development
 
 Uses `gts`, Google's base `typescript` environment configuration.