Added response status feature to package

Author: gabbyTI

.github/workflows/run-tests.yml

@@ -16,8 +16,8 @@ jobs:
       fail-fast: true
       matrix:
         os: [ubuntu-latest, windows-latest]
-        node: [16, 18, 20]  # Specify Node.js versions to test
-        npm: [6, 7, 8]      # Specify npm versions to test
+        node: [21, 22, 23]  # Specify Node.js versions to test
+        npm: [9,10]      # Specify npm versions to test
     name: Test Node.js${{ matrix.node }} and npm${{ matrix.npm }} on ${{ matrix.os }}
 
     steps:
@@ -46,4 +46,4 @@ jobs:
         run: npm list --depth=0
 
       - name: Execute tests
-        run: npm test -- --ci
+        run: npm test -- --ci --verbose

README.md

@@ -24,21 +24,20 @@ npm install @decodeblock/expressjs-api-utility
 ## Usage
 
 ### Example
-Using the `ApiResponder` class for handling JSON responses in an ExpressJS application:
+Using the `ResponseStatus` and `ApiResponder` class for handling JSON responses in an ExpressJS application:
 
 ```javascript
 const express = require('express');
-const ApiResponder = require('@decodeblock/expressjs-api-utility');
+const { ApiResponder, ResponseStatus } = require('@decodeblock/expressjs-api-utility');
 
 const app = express();
-const apiResponder = new ApiResponder();
 
 app.get('/success', (req, res) => {
-    apiResponder.successResponse(res, 'Request was successful', 200, { data: 'Your data here' });
+    ApiResponder.successResponse(res, 'Request was successful', ResponseStatus.HTTP_OK, { data: 'Your data here' });
 });
 
 app.get('/failure', (req, res) => {
-    apiResponder.failureResponse(res, 'Request failed', 400, { error: 'Bad Request' });
+    ApiResponder.failureResponse(res, 'Request failed', ResponseStatus.HTTP_NOT_FOUND, { error: 'Bad Request' });
 });
 
 app.listen(3000, () => {

package-lock.json

@@ -0,0 +1,129 @@
+const HTTP_CONTINUE = 100;
+const HTTP_SWITCHING_PROTOCOLS = 101;
+const HTTP_PROCESSING = 102; // RFC2518
+const HTTP_EARLY_HINTS = 103; // RFC8297
+const HTTP_OK = 200;
+const HTTP_CREATED = 201;
+const HTTP_ACCEPTED = 202;
+const HTTP_NON_AUTHORITATIVE_INFORMATION = 203;
+const HTTP_NO_CONTENT = 204;
+const HTTP_RESET_CONTENT = 205;
+const HTTP_PARTIAL_CONTENT = 206;
+const HTTP_MULTI_STATUS = 207; // RFC4918
+const HTTP_ALREADY_REPORTED = 208; // RFC5842
+const HTTP_IM_USED = 226; // RFC3229
+const HTTP_MULTIPLE_CHOICES = 300;
+const HTTP_MOVED_PERMANENTLY = 301;
+const HTTP_FOUND = 302;
+const HTTP_SEE_OTHER = 303;
+const HTTP_NOT_MODIFIED = 304;
+const HTTP_USE_PROXY = 305;
+const HTTP_RESERVED = 306;
+const HTTP_TEMPORARY_REDIRECT = 307;
+const HTTP_PERMANENTLY_REDIRECT = 308; // RFC7238
+const HTTP_BAD_REQUEST = 400;
+const HTTP_UNAUTHORIZED = 401;
+const HTTP_PAYMENT_REQUIRED = 402;
+const HTTP_FORBIDDEN = 403;
+const HTTP_NOT_FOUND = 404;
+const HTTP_METHOD_NOT_ALLOWED = 405;
+const HTTP_NOT_ACCEPTABLE = 406;
+const HTTP_PROXY_AUTHENTICATION_REQUIRED = 407;
+const HTTP_REQUEST_TIMEOUT = 408;
+const HTTP_CONFLICT = 409;
+const HTTP_GONE = 410;
+const HTTP_LENGTH_REQUIRED = 411;
+const HTTP_PRECONDITION_FAILED = 412;
+const HTTP_REQUEST_ENTITY_TOO_LARGE = 413;
+const HTTP_REQUEST_URI_TOO_LONG = 414;
+const HTTP_UNSUPPORTED_MEDIA_TYPE = 415;
+const HTTP_REQUESTED_RANGE_NOT_SATISFIABLE = 416;
+const HTTP_EXPECTATION_FAILED = 417;
+const HTTP_I_AM_A_TEAPOT = 418; // RFC2324
+const HTTP_MISDIRECTED_REQUEST = 421; // RFC7540
+const HTTP_UNPROCESSABLE_ENTITY = 422; // RFC4918
+const HTTP_LOCKED = 423; // RFC4918
+const HTTP_FAILED_DEPENDENCY = 424; // RFC4918
+const HTTP_TOO_EARLY = 425; // RFC-ietf-httpbis-replay-04
+const HTTP_UPGRADE_REQUIRED = 426; // RFC2817
+const HTTP_PRECONDITION_REQUIRED = 428; // RFC6585
+const HTTP_TOO_MANY_REQUESTS = 429; // RFC6585
+const HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE = 431; // RFC6585
+const HTTP_UNAVAILABLE_FOR_LEGAL_REASONS = 451;
+const HTTP_INTERNAL_SERVER_ERROR = 500;
+const HTTP_NOT_IMPLEMENTED = 501;
+const HTTP_BAD_GATEWAY = 502;
+const HTTP_SERVICE_UNAVAILABLE = 503;
+const HTTP_GATEWAY_TIMEOUT = 504;
+const HTTP_VERSION_NOT_SUPPORTED = 505;
+const HTTP_VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL = 506; // RFC2295
+const HTTP_INSUFFICIENT_STORAGE = 507; // RFC4918
+const HTTP_LOOP_DETECTED = 508; // RFC5842
+const HTTP_NOT_EXTENDED = 510; // RFC2774
+const HTTP_NETWORK_AUTHENTICATION_REQUIRED = 511; // RFC6585
+
+module.exports = {
+	HTTP_CONTINUE,
+	HTTP_SWITCHING_PROTOCOLS,
+	HTTP_PROCESSING,
+	HTTP_EARLY_HINTS,
+	HTTP_OK,
+	HTTP_CREATED,
+	HTTP_ACCEPTED,
+	HTTP_NON_AUTHORITATIVE_INFORMATION,
+	HTTP_NO_CONTENT,
+	HTTP_RESET_CONTENT,
+	HTTP_PARTIAL_CONTENT,
+	HTTP_MULTI_STATUS,
+	HTTP_ALREADY_REPORTED,
+	HTTP_IM_USED,
+	HTTP_MULTIPLE_CHOICES,
+	HTTP_MOVED_PERMANENTLY,
+	HTTP_FOUND,
+	HTTP_SEE_OTHER,
+	HTTP_NOT_MODIFIED,
+	HTTP_USE_PROXY,
+	HTTP_RESERVED,
+	HTTP_TEMPORARY_REDIRECT,
+	HTTP_PERMANENTLY_REDIRECT,
+	HTTP_BAD_REQUEST,
+	HTTP_UNAUTHORIZED,
+	HTTP_PAYMENT_REQUIRED,
+	HTTP_FORBIDDEN,
+	HTTP_NOT_FOUND,
+	HTTP_METHOD_NOT_ALLOWED,
+	HTTP_NOT_ACCEPTABLE,
+	HTTP_PROXY_AUTHENTICATION_REQUIRED,
+	HTTP_REQUEST_TIMEOUT,
+	HTTP_CONFLICT,
+	HTTP_GONE,
+	HTTP_LENGTH_REQUIRED,
+	HTTP_PRECONDITION_FAILED,
+	HTTP_REQUEST_ENTITY_TOO_LARGE,
+	HTTP_REQUEST_URI_TOO_LONG,
+	HTTP_UNSUPPORTED_MEDIA_TYPE,
+	HTTP_REQUESTED_RANGE_NOT_SATISFIABLE,
+	HTTP_EXPECTATION_FAILED,
+	HTTP_I_AM_A_TEAPOT,
+	HTTP_MISDIRECTED_REQUEST,
+	HTTP_UNPROCESSABLE_ENTITY,
+	HTTP_LOCKED,
+	HTTP_FAILED_DEPENDENCY,
+	HTTP_TOO_EARLY,
+	HTTP_UPGRADE_REQUIRED,
+	HTTP_PRECONDITION_REQUIRED,
+	HTTP_TOO_MANY_REQUESTS,
+	HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE,
+	HTTP_UNAVAILABLE_FOR_LEGAL_REASONS,
+	HTTP_INTERNAL_SERVER_ERROR,
+	HTTP_NOT_IMPLEMENTED,
+	HTTP_BAD_GATEWAY,
+	HTTP_SERVICE_UNAVAILABLE,
+	HTTP_GATEWAY_TIMEOUT,
+	HTTP_VERSION_NOT_SUPPORTED,
+	HTTP_VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL,
+	HTTP_INSUFFICIENT_STORAGE,
+	HTTP_LOOP_DETECTED,
+	HTTP_NOT_EXTENDED,
+	HTTP_NETWORK_AUTHENTICATION_REQUIRED,
+};

src/ResponseStatus.js

@@ -1,5 +1,7 @@
 const ApiResponder = require('./ApiResponder');
+const ResponseStatus = require('./ResponseStatus');
 
 module.exports = {
-    ApiResponder,
+  ApiResponder,
+  ResponseStatus,
 };

src/index.js

@@ -1,6 +1,7 @@
 const express = require('express');
 const request = require('supertest');
 const ApiResponder = require('../src/ApiResponder');
+const ResponseStatus = require('../src/ResponseStatus');
 
 describe('ApiResponder', () => {
     let app;

tests/ApiResponder.test.js

@@ -0,0 +1,16 @@
+const ResponseStatus = require('../src/ResponseStatus');
+
+describe('ResponseStatus Module', () => {
+    test('should export the correct HTTP_OK value', () => {
+        expect(ResponseStatus.HTTP_OK).toBe(200);
+    });
+
+    test('should export the correct HTTP_NOT_FOUND value', () => {
+        expect(ResponseStatus.HTTP_NOT_FOUND).toBe(404);
+    });
+
+    test('should contain all expected status codes', () => {
+        expect(Object.keys(ResponseStatus)).toContain('HTTP_INTERNAL_SERVER_ERROR');
+        expect(ResponseStatus.HTTP_INTERNAL_SERVER_ERROR).toBe(500);
+    });
+});