Add overload to standardForbiddenResponse that takes an entity (#232)

Closes #231

__tests__/express/kiwi-standard-responses-express.t.ts

@@ -181,6 +181,19 @@ describe("KiwiStandardResponses", () => {
     });
   });
 
+  describe("standardForbiddenResponseWithEntity", () => {
+    it("should setup a standard 403 response", () => {
+      KiwiStandardResponsesExpress.standardForbiddenResponseWithEntity(res, {
+        foo: "bar",
+      });
+
+      expect(res.status).toHaveBeenCalledWith(403);
+      expect(res.json).toHaveBeenCalledWith({
+        foo: "bar",
+      });
+    });
+  });
+
   describe("standardErrorResponse", () => {
     it("should setup a standard error response with given status", () => {
       KiwiStandardResponsesExpress.standardErrorResponse(res, 500, "Whoops");

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kiwiproject/kiwi-js",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "KiwiJS is a utility library. It contains a variety of utilities that we have built over time and find useful. Most of these utilities are ports from the Java Kiwi library.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/express/kiwi-standard-responses-express.ts

@@ -171,6 +171,19 @@ const standardForbiddenResponse = (res: Response, errorMessage: string) => {
   res.status(403).json(new ErrorResponse(errorMessage).toMap());
 };
 
+/**
+ * Returns a 403 Forbidden response containing a provided entity.
+ *
+ * @param res          the Express Response
+ * @param entity the entity to use
+ */
+const standardForbiddenResponseWithEntity = (
+  res: Response,
+  entity: unknown,
+) => {
+  res.status(403).json(entity);
+};
+
 /**
  * Returns a response having the given status and an {@link ErrorResponse} entity which uses {@code errorMessage}
  * as the detailed error message.
@@ -227,6 +240,7 @@ export const KiwiStandardResponsesExpress = {
   standardErrorResponse,
   standardUnauthorizedResponse,
   standardForbiddenResponse,
+  standardForbiddenResponseWithEntity,
   standardNotFoundResponse,
   standardBadRequestResponse,
 };