core-services-sdk 1.3.4 → 1.3.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "core-services-sdk",
-  "version": "1.3.4",
+  "version": "1.3.5",
   "main": "src/index.js",
   "type": "module",
   "scripts": {

package/src/http/http.js

@@ -10,10 +10,22 @@ const JSON_HEADER = {
   'Content-Type': 'application/json',
 }
 
+/**
+ * Checks if the HTTP status is considered successful (2xx).
+ *
+ * @param {Response} res - The fetch response object.
+ * @returns {boolean} `true` if status code is between 200-299.
+ */
 const isOkStatus = ({ status }) =>
-  // Range of response OK
   status >= httpStatus.OK && status < httpStatus.MULTIPLE_CHOICES
 
+/**
+ * Verifies response status and throws a structured HttpError if not OK.
+ *
+ * @param {Response} res - The fetch response object.
+ * @throws {HttpError} When the response status is not OK.
+ * @returns {Response} The response if status is OK.
+ */
 const checkStatus = async (res) => {
   if (!isOkStatus(res)) {
     const text = await res.text()
@@ -30,63 +42,95 @@ const checkStatus = async (res) => {
   return res
 }
 
+/**
+ * Reads the raw text from a fetch response.
+ *
+ * @param {Response} response - The fetch response.
+ * @returns {Promise<string>} The text body.
+ */
 const getTextResponse = async (response) => {
-  const text = await response.text()
-  return text
+  return await response.text()
 }
 
+/**
+ * Attempts to parse a JSON string.
+ *
+ * @param {string} responseText - A raw JSON string.
+ * @returns {Object} Parsed JSON object.
+ * @throws {SyntaxError} If the string is not valid JSON.
+ */
 const tryConvertJsonResponse = (responseText) => {
   try {
-    const obj = JSON.parse(responseText)
-    return obj
+    return JSON.parse(responseText)
   } catch (error) {
     error.responseText = responseText
     throw error
   }
 }
 
+/**
+ * Attempts to extract a JSON object from a fetch response.
+ *
+ * @param {Response} response - The fetch response.
+ * @returns {Promise<Object|string>} Parsed object or raw string on failure.
+ */
 const tryGetJsonResponse = async (response) => {
   let jsonText
   try {
-    jsonText = getTextResponse(response)
-    const obj = tryConvertJsonResponse(jsonText)
-    return obj
+    jsonText = await getTextResponse(response)
+    return tryConvertJsonResponse(jsonText)
   } catch (error) {
-    if (!jsonText) {
-      throw error
-    }
+    if (!jsonText) throw error
     return jsonText
   }
 }
 
+/**
+ * Attempts to extract an XML object from a fetch response.
+ *
+ * @param {Response} response - The fetch response.
+ * @returns {Promise<Object|string>} Parsed XML object or raw string.
+ */
 const tryGetXmlResponse = async (response) => {
   let xmlText
   try {
     xmlText = await getTextResponse(response)
-    const xml = await parseStringPromise(xmlText)
-    return xml
+    return await parseStringPromise(xmlText)
   } catch (error) {
-    if (!xmlText) {
-      throw error
-    }
+    if (!xmlText) throw error
     return xmlText
   }
 }
 
+/**
+ * Extracts and parses the fetch response body based on expected type.
+ *
+ * @param {Response} response - The fetch response.
+ * @param {string} responseType - The expected response type ('json', 'xml', 'text').
+ * @returns {Promise<any>} The parsed response payload.
+ */
 const getResponsePayload = async (response, responseType) => {
   switch (responseType) {
     case ResponseType.json:
       return tryGetJsonResponse(response)
-
     case ResponseType.xml:
       return tryGetXmlResponse(response)
-
     default:
     case ResponseType.text:
       return getTextResponse(response)
   }
 }
 
+/**
+ * Sends an HTTP GET request.
+ *
+ * @param {Object} params
+ * @param {string} params.url - The target URL.
+ * @param {Object} [params.headers] - Optional custom headers.
+ * @param {string} [params.credentials='include'] - Credential mode.
+ * @param {string} [params.expectedType='json'] - Response type.
+ * @returns {Promise<any>} Parsed response data.
+ */
 export const get = async ({
   url,
   headers = {},
@@ -95,18 +139,24 @@ export const get = async ({
 }) => {
   const response = await fetch(url, {
     method: HTTP_METHODS.GET,
-    headers: {
-      ...JSON_HEADER,
-      ...headers,
-    },
+    headers: { ...JSON_HEADER, ...headers },
     ...(credentials ? { credentials } : {}),
   })
-
   await checkStatus(response)
-  const data = await getResponsePayload(response, expectedType)
-  return data
+  return await getResponsePayload(response, expectedType)
 }
 
+/**
+ * Sends an HTTP POST request.
+ *
+ * @param {Object} params
+ * @param {string} params.url - The target URL.
+ * @param {Object} params.body - Body data to send.
+ * @param {Object} [params.headers] - Optional custom headers.
+ * @param {string} [params.credentials='include'] - Credential mode.
+ * @param {string} [params.expectedType='json'] - Response type.
+ * @returns {Promise<any>} Parsed response data.
+ */
 export const post = async ({
   url,
   body,
@@ -116,18 +166,20 @@ export const post = async ({
 }) => {
   const response = await fetch(url, {
     method: HTTP_METHODS.POST,
-    headers: {
-      ...JSON_HEADER,
-      ...headers,
-    },
+    headers: { ...JSON_HEADER, ...headers },
     body: JSON.stringify(body),
     ...(credentials ? { credentials } : {}),
   })
   await checkStatus(response)
-  const data = await getResponsePayload(response, expectedType)
-  return data
+  return await getResponsePayload(response, expectedType)
 }
 
+/**
+ * Sends an HTTP PUT request.
+ *
+ * @param {Object} params - Same as `post`.
+ * @returns {Promise<any>} Parsed response data.
+ */
 export const put = async ({
   url,
   body,
@@ -137,19 +189,20 @@ export const put = async ({
 }) => {
   const response = await fetch(url, {
     method: HTTP_METHODS.PUT,
-    headers: {
-      ...JSON_HEADER,
-      ...headers,
-    },
+    headers: { ...JSON_HEADER, ...headers },
     body: JSON.stringify(body),
     ...(credentials ? { credentials } : {}),
   })
-
   await checkStatus(response)
-  const data = await getResponsePayload(response, expectedType)
-  return data
+  return await getResponsePayload(response, expectedType)
 }
 
+/**
+ * Sends an HTTP PATCH request.
+ *
+ * @param {Object} params - Same as `post`.
+ * @returns {Promise<any>} Parsed response data.
+ */
 export const patch = async ({
   url,
   body,
@@ -159,19 +212,20 @@ export const patch = async ({
 }) => {
   const response = await fetch(url, {
     method: HTTP_METHODS.PATCH,
-    headers: {
-      ...JSON_HEADER,
-      ...headers,
-    },
+    headers: { ...JSON_HEADER, ...headers },
     body: JSON.stringify(body),
     ...(credentials ? { credentials } : {}),
   })
-
   await checkStatus(response)
-  const data = await getResponsePayload(response, expectedType)
-  return data
+  return await getResponsePayload(response, expectedType)
 }
 
+/**
+ * Sends an HTTP DELETE request.
+ *
+ * @param {Object} params - Same as `post`, but body is optional.
+ * @returns {Promise<any>} Parsed response data.
+ */
 export const deleteApi = async ({
   url,
   body,
@@ -181,19 +235,24 @@ export const deleteApi = async ({
 }) => {
   const response = await fetch(url, {
     method: HTTP_METHODS.DELETE,
-    headers: {
-      ...JSON_HEADER,
-      ...headers,
-    },
+    headers: { ...JSON_HEADER, ...headers },
     ...(body ? { body: JSON.stringify(body) } : {}),
     ...(credentials ? { credentials } : {}),
   })
-
   await checkStatus(response)
-  const data = await getResponsePayload(response, expectedType)
-  return data
+  return await getResponsePayload(response, expectedType)
 }
 
+/**
+ * Consolidated HTTP client with method shortcuts.
+ *
+ * @namespace http
+ * @property {Function} get - HTTP GET method.
+ * @property {Function} post - HTTP POST method.
+ * @property {Function} put - HTTP PUT method.
+ * @property {Function} patch - HTTP PATCH method.
+ * @property {Function} deleteApi - HTTP DELETE method.
+ */
 export const http = {
   get,
   put,

package/src/index.js

@@ -1,12 +1,17 @@
-export * from './core/index.js'
-export * from './crypto/index.js'
-export * from './logger/index.js'
 export * from './fastify/index.js'
 export * from './mongodb/index.js'
+export * from './crypto/crypto.js'
 export * from './rabbit-mq/index.js'
+export * from './logger/get-logger.js'
+export * from './core/regex-utils.js'
 export * as http from './http/http.js'
 export * from './http/responseType.js'
+export * from './crypto/encryption.js'
+export * from './core/otp-generators.js'
+export * from './core/sanitize-objects.js'
+export * from './core/normalize-to-array.js'
 export { initMailer } from './mailer/index.js'
+export * from './core/combine-unique-arrays.js'
 export { HttpError } from './http/HttpError.js'
 export { Mailer } from './mailer/mailer.service.js'
 export { TransportFactory } from './mailer/transport.factory.js'