@adobe/spacecat-shared-http-utils 1.2.1 → 1.3.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-http-utils-v1.3.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-http-utils-v1.3.0...@adobe/spacecat-shared-http-utils-v1.3.1) (2024-05-29)
+
+
+### Bug Fixes
+
+* Refactor createResponse Function to Handle Non-JSON Content-Types ([#244](https://github.com/adobe/spacecat-shared/issues/244)) ([7675f35](https://github.com/adobe/spacecat-shared/commit/7675f35c9ae8644b43b489136da66c21c2d7393b))
+
+# [@adobe/spacecat-shared-http-utils-v1.3.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-http-utils-v1.2.1...@adobe/spacecat-shared-http-utils-v1.3.0) (2024-05-21)
+
+
+### Features
+
+* introduce google client ([#219](https://github.com/adobe/spacecat-shared/issues/219)) ([71eeb64](https://github.com/adobe/spacecat-shared/commit/71eeb64a7efe2037b5d40f0c62668b9eaf41aeb8))
+
 # [@adobe/spacecat-shared-http-utils-v1.2.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-http-utils-v1.2.0...@adobe/spacecat-shared-http-utils-v1.2.1) (2024-05-03)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-http-utils",
-  "version": "1.2.1",
+  "version": "1.3.1",
   "description": "Shared modules of the Spacecat Services - HTTP Utils",
   "type": "module",
   "main": "src/index.js",

package/src/index.d.ts

@@ -22,3 +22,5 @@ export declare function badRequest(message?: string, headers?: object): Response
 export declare function notFound(message?: string, headers?: object): Response;
 
 export declare function internalServerError(message?: string, headers?: object): Response;
+
+export declare function found(location: string): Response;

package/src/index.js

@@ -12,22 +12,39 @@
 
 import { Response } from '@adobe/fetch';
 
+const HEADER_CONTENT_TYPE = 'content-type';
+const HEADER_ERROR = 'x-error';
+
+const CONTENT_TYPE_JSON = 'application/json';
+
 /**
- * Creates a response with a JSON body. Defaults to 200 status.
- * @param {object} body - JSON body.
- * @param {number} status - Optional status code.
- * @param {object} headers - Optional headers.
+ * Creates a response with a JSON body if the content-type is JSON. Defaults to 200 status.
+ * If a header is already defined and has a different content-type, it is handled accordingly.
+ * @param {object} body - Response body.
+ * @param {number} [status=200] - Optional status code.
+ * @param {object} [headers={}] - Optional headers.
  * @return {Response} Response.
  */
 export function createResponse(body, status = 200, headers = {}) {
-  return new Response(
-    body === '' ? '' : JSON.stringify(body),
-    {
-      headers: { 'content-type': 'application/json; charset=utf-8', ...headers },
-      status,
-    },
-  );
+  let responseBody = body;
+
+  // Check if headers already contain a 'content-type' key
+  if (!headers[HEADER_CONTENT_TYPE]) {
+    // Set content-type to JSON if not already set
+    Object.assign(headers, { [HEADER_CONTENT_TYPE]: `${CONTENT_TYPE_JSON}; charset=utf-8` });
+  }
+
+  // Stringify body if content-type is JSON
+  if (headers[HEADER_CONTENT_TYPE].includes(CONTENT_TYPE_JSON)) {
+    responseBody = body === '' ? '' : JSON.stringify(body);
+  }
+
+  return new Response(responseBody, {
+    headers,
+    status,
+  });
 }
+
 export function ok(body = '') {
   return createResponse(body, 200);
 }
@@ -40,23 +57,29 @@ export function noContent(headers = {}) {
   return createResponse('', 204, headers);
 }
 
+export function found(location, body = '') {
+  return createResponse(body, 302, {
+    Location: location,
+  });
+}
+
 export function badRequest(message = 'bad request', headers = {}) {
   return createResponse({ message }, 400, {
-    'x-error': message,
+    [HEADER_ERROR]: message,
     ...headers,
   });
 }
 
 export function notFound(message = 'not found', headers = {}) {
   return createResponse({ message }, 404, {
-    'x-error': message,
+    [HEADER_ERROR]: message,
     ...headers,
   });
 }
 
 export function internalServerError(message = 'internal server error', headers = {}) {
   return createResponse({ message }, 500, {
-    'x-error': message,
+    [HEADER_ERROR]: message,
     ...headers,
   });
 }