@izara_frontend/remote-endpoint 1.0.1 → 1.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@izara_frontend/remote-endpoint",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "create standard frontend query endpoint",
   "main": "index.js",
   "type": "module",

package/src/remoteEndpoint.js

@@ -3,24 +3,22 @@ import {
 } from "@izaraFrontends/store";
 
 /**
+ * Creates a GET endpoint configuration for fetching an object based on its type.
+ * Retrieves the base URL from the store and constructs a query endpoint with POST method.
  *
- * @param {object} objType
- * @param {string} ojType.serviceTag
- * @param {string} objType.objectType
- *
- * @returns {object} query endpoint object
+ * @param {object} objType - The object type configuration.
+ * @param {string} objType.serviceTag - The service tag identifier.
+ * @param {string} objType.objectType - The object type identifier.
+ * @returns {object|null} Query endpoint object with name, type, and query configuration, or null if invalid.
  */
 export function createGetEndpoint(objType) {
   if (!validateObjType(objType)) {
     return null;
   }
 
-  const objTypeConcat = `${objType.serviceTag}_${objType.objectType}`;
-  const storeData = store.getState();
-
-  const getEndpoints = storeData?.rootConfigSlice?.rootConfig?.endpoints?.getEndpoints ?? {};
+  const baseUrlLocations = ['rootConfig', 'endpoints', 'getEndpoints', `${objType.serviceTag}_${objType.objectType}`];
+  const baseUrl = getBaseUrlFromStoreSlice(baseUrlLocations)
 
-  const baseUrl = getEndpoints[objTypeConcat];
 
   if (baseUrl && typeof (baseUrl) === 'string') {
     return {
@@ -51,35 +49,19 @@ export function createGetEndpoint(objType) {
 
 
 /**
+ * Creates a custom query endpoint with configurable URL path, method, and cache key.
+ * Retrieves the base URL from the store based on provided locations array.
  *
- * @param {object} objType
- * @param {string} ojType.serviceTag
- * @param {string} objType.objectType
- *
- * @returns {object} query endpoint object
+ * @param {string[]} baseUrlLocations - Array of strings representing the path to the base URL in the store slice.
+ * @param {string} endpointName - The name of the endpoint.
+ * @param {string} pathParams - The path parameters to append to the base URL.
+ * @param {string} method - The HTTP method (e.g., 'GET', 'POST', 'PUT', 'DELETE').
+ * @param {object} options - Optional configuration.
+ * @param {object} options.customCacheKey - Custom cache key configuration for query caching.
+ * @returns {object|null} Query endpoint object with name, type, and query configuration, or null if base URL not found.
  */
 export function createQueryEndpoint(baseUrlLocations = [], endpointName, pathParams, method, { customCacheKey = {} } = {}) {
-
-  const storeData = store.getState();
-
-  let baseUrl = null;
-  let currentSlice = storeData?.rootConfigSlice
-
-  for (let urlLocationIdx = 0; urlLocationIdx > baseUrlLocations.length; urlLocationIdx++) {
-    const baseUrlLocation = baseUrlLocations[urlLocationIdx];
-
-    if (currentSlice && typeof (currentSlice) === 'object') {
-      if (currentSlice.hasOwnProperty(baseUrlLocation) && urlLocationIdx !== baseUrlLocations.length - 1) {
-        currentSlice = currentSlice[baseUrlLocation];
-      } else if (currentSlice.hasOwnProperty(baseUrlLocation) && urlLocationIdx === baseUrlLocations.length - 1) {
-        if (typeof (currentSlice[baseUrlLocation] === 'string')) {
-          baseUrl = currentSlice[baseUrlLocation];
-        }
-      }
-    } else {
-      break;
-    }
-  }
+  const baseUrl = getBaseUrlFromStoreSlice(baseUrlLocations);
 
   if (baseUrl) {
     return {
@@ -87,7 +69,7 @@ export function createQueryEndpoint(baseUrlLocations = [], endpointName, pathPar
       type: "query",
       query: {
         query: ({ body, headers }) => ({
-          url: `https://${baseUrlLocations}.execute-api.us-east-2.amazonaws.com/${pathParams}`,
+          url: `https://${baseUrl}.execute-api.us-east-2.amazonaws.com/${pathParams}`,
           method: method,
           body: { ...body },
           headers: {
@@ -103,50 +85,47 @@ export function createQueryEndpoint(baseUrlLocations = [], endpointName, pathPar
 }
 
 /**
+ * Creates a mutation endpoint for modifying data with configurable URL path and method.
+ * Retrieves the base URL from the store based on provided locations array.
  *
- * @param {object} objType
- * @param {string} ojType.serviceTag
- * @param {string} objType.objectType
- *
- * @returns {object} mutation endpoint object
+ * @param {string[]} baseUrlLocations - Array of strings representing the path to the base URL in the store slice.
+ * @param {string} endpointName - The name of the endpoint.
+ * @param {string} pathParams - The path parameters to append to the base URL.
+ * @param {string} method - The HTTP method (e.g., 'POST', 'PUT', 'PATCH', 'DELETE').
+ * @returns {object|null} Mutation endpoint object with name, type, and query configuration, or null if base URL not found.
  */
 export function createMutationEndpoint(baseUrlLocations = [], endpointName, pathParams, method) {
-  const storeData = store.getState();
+  const baseUrl = getBaseUrlFromStoreSlice(baseUrlLocations)
 
-  let baseUrl = null;
-  let currentSlice = storeData?.rootConfigSlice
-  for (let urlLocationIdx = 0; urlLocationIdx > baseUrlLocations.length; urlLocationIdx++) {
-    const baseUrlLocation = baseUrlLocations[urlLocationIdx];
-
-    if (currentSlice && typeof (currentSlice) === 'object') {
-      if (currentSlice.hasOwnProperty(baseUrlLocation) && urlLocationIdx !== baseUrlLocations.length - 1) {
-        currentSlice = currentSlice[baseUrlLocation];
-      } else if (currentSlice.hasOwnProperty(baseUrlLocation) && urlLocationIdx === baseUrlLocations.length - 1) {
-        if (typeof (currentSlice[baseUrlLocation] === 'string')) {
-          baseUrl = currentSlice[baseUrlLocation];
-        }
+  if (baseUrl) {
+    return {
+      name: `${endpointName}`,
+      type: "mutation",
+      query: {
+        query: (body, headers = {},) => ({
+          url: `https://${baseUrl}.execute-api.us-east-2.amazonaws.com/${pathParams}`,
+          method: method,
+          body: { ...body },
+          headers: {
+            ...headers
+          }
+        }),
       }
-    } else {
-      break;
-    }
-  }
-
-  return {
-    name: `${endpointName}`,
-    type: "mutation",
-    query: {
-      query: (body, headers = {},) => ({
-        url: `https://${baseUrl}.execute-api.us-east-2.amazonaws.com/${pathParams}`,
-        method: method,
-        body: { ...body },
-        headers: {
-          ...headers
-        }
-      }),
     }
+  } else {
+    return null;
   }
 }
 
+/**
+ * Validates the given object type to ensure it contains valid serviceTag and objectType properties.
+ * Both properties must be non-empty strings after trimming.
+ *
+ * @param {object} objType - The object to validate.
+ * @param {string} objType.serviceTag - The service tag string to validate.
+ * @param {string} objType.objectType - The object type string to validate.
+ * @returns {boolean} True if the object type is valid, otherwise false.
+ */
 function validateObjType(objType) {
   if (objType === null || objType === undefined) {
     return false;
@@ -176,4 +155,35 @@ function validateObjType(objType) {
   } else {
     return true;
   }
+}
+
+/**
+ * Retrieves the base URL from the store slice based on the provided location path.
+ * Traverses the store's rootConfigSlice following the path specified in baseUrlLocations array.
+ *
+ * @param {string[]} baseUrlLocations - An array of strings representing the path to the base URL in the store slice.
+ * @returns {string|null} The base URL if found, otherwise null.
+ */
+function getBaseUrlFromStoreSlice(baseUrlLocations = []) {
+  const storeData = store.getState();
+
+  let baseUrl = null;
+  let currentSlice = storeData?.rootConfigSlice
+
+  for (let urlLocationIdx = 0; urlLocationIdx < baseUrlLocations.length; urlLocationIdx++) {
+    const baseUrlLocation = baseUrlLocations[urlLocationIdx];
+
+    if (currentSlice && typeof (currentSlice) === 'object') {
+      if (currentSlice.hasOwnProperty(baseUrlLocation) && urlLocationIdx !== baseUrlLocations.length - 1) {
+        currentSlice = currentSlice[baseUrlLocation];
+      } else if (currentSlice.hasOwnProperty(baseUrlLocation) && urlLocationIdx === baseUrlLocations.length - 1) {
+        if (typeof currentSlice[baseUrlLocation] === 'string') {
+          baseUrl = currentSlice[baseUrlLocation];
+        }
+      }
+    } else {
+      break;
+    }
+  }
+  return baseUrl;
 }