@63klabs/cache-data 1.3.8 → 1.3.10

package/src/lib/dao-endpoint.js

@@ -8,10 +8,10 @@
  * 
  * The class can be used as a template and modified to provide additional
  * logic, query, filtering, and manipulation before/after data is sent/received
- * via the APIRequest class.
+ * via the ApiRequest class.
  * 
  * The class itself is not exposed, instead various functions can be used
- * to access the class. For exmaple, get(connection, data)
+ * to access the class. For example, send(connection, data)
  * 
  * The connection parameter is used to pass connection information to the 
  * API (host, path, query, etc).
@@ -21,8 +21,8 @@
  * 
  * @example
  *  // access function that utilizes the class
- *  const get = async (connection, data = null) => {
- *      return (new Endpoint(connection).get());
+ *  const send = async (connection, data = null) => {
+ *      return (new Endpoint(connection).send());
  *  };
  */
 
@@ -53,12 +53,11 @@
  * -----------------------------------------------------------------------------
  */
 
-"use strict";
-
-const tools = require("./tools/index.js");
+const DebugAndLog = require("./tools/DebugAndLog.class.js");
+const ApiRequest = require("./tools/ApiRequest.class.js");
 
 /**
- * Makes a GET request to a remote endpoint with the specified connection configuration.
+ * Makes a request to a remote endpoint with the specified connection configuration.
  * 
  * This function provides a simple interface for making HTTP requests to external APIs
  * or services. It supports both URI-based and component-based (protocol/host/path) 
@@ -70,12 +69,11 @@ const tools = require("./tools/index.js");
  * @param {ConnectionObject} connection - Connection configuration object specifying the endpoint details
  * @param {Object} [query={}] - Additional query data to merge with connection parameters. If query.parameters is provided, it will be merged with connection.parameters
  * @returns {Promise<{success: boolean, statusCode: number, body: Object|string|null, headers: Object}>} Response object containing success status, HTTP status code, parsed body, and response headers
- * @throws {Error} Throws an error if the request fails due to network issues or invalid configuration
  * 
  * @example
  * // Using separate host and path
  * const { endpoint } = require("@63klabs/cache-data");
- * const response = await endpoint.get(
+ * const response = await endpoint.send(
  *   { host: "api.example.com", path: "/data" },
  *   { parameters: { q: "Chicago" } }
  * );
@@ -84,7 +82,7 @@ const tools = require("./tools/index.js");
  * @example
  * // Using complete URI
  * const { endpoint } = require("@63klabs/cache-data");
- * const response = await endpoint.get(
+ * const response = await endpoint.send(
  *   { uri: "https://api.example.com/data" },
  *   { parameters: { q: "Chicago" } }
  * );
@@ -93,7 +91,7 @@ const tools = require("./tools/index.js");
  * @example
  * // With custom headers and timeout
  * const { endpoint } = require("@63klabs/cache-data");
- * const response = await endpoint.get({
+ * const response = await endpoint.send({
  *   host: "api.example.com",
  *   path: "/secure/data",
  *   headers: { "Authorization": "Bearer token123" },
@@ -103,19 +101,36 @@ const tools = require("./tools/index.js");
  * @example
  * // POST request with body
  * const { endpoint } = require("@63klabs/cache-data");
- * const response = await endpoint.get({
+ * const response = await endpoint.send({
  *   method: "POST",
  *   uri: "https://api.example.com/submit",
  *   body: JSON.stringify({ name: "John", age: 30 }),
  *   headers: { "Content-Type": "application/json" }
  * });
  */
-const get = async (connection, query = {}) => {
+const send = async (connection, query = {}) => {
 	if (query === null) { query = {} };
-	return (new Endpoint(connection, query).get());
+	return (new Endpoint(connection, query).send());
+};
+
+/**
+ * @deprecated Use send() instead. This function is maintained for backwards compatibility.
+ * @see send
+ */
+const get = async (connection, query = {}) => {
+	return send(connection, query);
 };
 
 /**
+ * @deprecated Use send() instead. This function is maintained for backwards compatibility.
+ * @see send
+ */
+const getDataDirectFromURI = async (connection, query = {}) => {
+	return send(connection, query);
+};
+
+/**
+ * @class Endpoint
  * Endpoint request class for making HTTP requests to remote APIs.
  * 
  * This class provides a bare-bones implementation for making API requests and can be used
@@ -124,19 +139,19 @@ const get = async (connection, query = {}) => {
  * merging, and automatic JSON parsing of responses.
  * 
  * The class is typically not instantiated directly but accessed through convenience functions
- * like `endpoint.get()`. However, it can be extended to add custom pre/post-processing logic.
+ * like `endpoint.send()`. However, it can be extended to add custom pre/post-processing logic.
  * 
  * @example
  * // Direct instantiation (advanced usage)
  * const endpoint = new Endpoint({ host: "api.example.com", path: "/data" });
- * const response = await endpoint.get();
+ * const response = await endpoint.send();
  * 
  * @example
  * // Extending for custom logic
  * class CustomEndpoint extends Endpoint {
- *   async get() {
+ *   async send() {
  *     // Custom pre-processing
- *     const response = await super.get();
+ *     const response = await super.send();
  *     // Custom post-processing
  *     return response;
  *   }
@@ -167,6 +182,9 @@ class Endpoint {
 	 */
 	constructor(connection, query = {}) {
 
+		/**
+		 * @property {Object|null} response - Configured response object
+		 */	
 		this.response = null;
 
 		// if query has parameters property then we will combine with connection parameters
@@ -180,6 +198,9 @@ class Endpoint {
 			}
 		}
 
+		/**
+		 * @property {Object} request - Configured request object
+		 */		
 		this.request = {
 			method: this._setRequestSetting(connection, "method", "GET"),
 			uri: this._setRequestSetting(connection, "uri", ""),
@@ -202,6 +223,8 @@ class Endpoint {
 	 * default value and returns that default. This ensures all request settings
 	 * have valid values.
 	 * 
+	 * @private
+	 * 
 	 * @param {ConnectionObject} connection - The connection object to check for the key
 	 * @param {string} key - The property key to check for and retrieve
 	 * @param {*} defaultValue - The default value to use if the key is not found
@@ -223,7 +246,7 @@ class Endpoint {
 	/**
 	 * Executes the HTTP request and returns the response.
 	 * 
-	 * This method sends the configured request to the remote endpoint using the APIRequest
+	 * This method sends the configured request to the remote endpoint using the ApiRequest
 	 * class. It automatically attempts to parse the response body as JSON. If the body is
 	 * not valid JSON, it is kept as text. The method caches the response so subsequent
 	 * calls return the same result without making additional requests.
@@ -232,12 +255,11 @@ class Endpoint {
 	 * request) or post-processing (after the response) logic.
 	 * 
 	 * @returns {Promise<{success: boolean, statusCode: number, body: Object|string|null, headers: Object}>} Response object with success status, HTTP status code, parsed body, and headers
-	 * @throws {Error} Throws an error if the request fails due to network issues, timeout, or invalid configuration
 	 * 
 	 * @example
-	 * // Basic usage through the get() function
+	 * // Basic usage through the send() function
 	 * const endpoint = new Endpoint({ host: "api.example.com", path: "/data" });
-	 * const response = await endpoint.get();
+	 * const response = await endpoint.send();
 	 * if (response.success) {
 	 *   console.log(response.body);
 	 * }
@@ -246,20 +268,20 @@ class Endpoint {
 	 * // Handling errors
 	 * try {
 	 *   const endpoint = new Endpoint({ uri: "https://api.example.com/data" });
-	 *   const response = await endpoint.get();
+	 *   const response = await endpoint.send();
 	 *   console.log(response.statusCode, response.body);
 	 * } catch (error) {
 	 *   console.error("Request failed:", error.message);
 	 * }
 	 */
-	async get() {
+	async send() {
 
 		if (this.response === null) {
 
 			// send the call
 			try {
 
-				tools.DebugAndLog.debug("Sending call", this.request);
+				DebugAndLog.debug("Sending call", this.request);
 				this.response = await this._call();                
 
 				// if it is not JSON we don't convert
@@ -274,11 +296,11 @@ class Endpoint {
 					this.response.body = body;
 
 				} catch (error) {
-					tools.DebugAndLog.debug("This isn't JSON so we'll keep as text and do nothing. This isn't a true error.");
+					DebugAndLog.debug("This isn't JSON so we'll keep as text and do nothing. This isn't a true error.");
 				}
 
 			} catch (error) {
-				tools.DebugAndLog.error(`Error in call to remote endpoint (${this.request.note}): ${error.message}`, error.stack);
+				DebugAndLog.error(`Error in call to remote endpoint (${this.request.note}): ${error.message}`, error.stack);
 			}
 
 		}
@@ -287,14 +309,15 @@ class Endpoint {
 	}
 
 	/**
-	 * Internal method that makes the actual HTTP request using the APIRequest class.
+	 * Internal method that makes the actual HTTP request using the ApiRequest class.
 	 * 
-	 * This method creates an APIRequest instance with the configured request settings
+	 * This method creates an ApiRequest instance with the configured request settings
 	 * and sends the request. It handles errors by logging them and returning a formatted
-	 * error response. This method is called internally by the get() method.
+	 * error response. This method is called internally by the send() method.
 	 * 
-	 * @returns {Promise<{success: boolean, statusCode: number, body: Object|string|null, headers: Object}>} Response object from the APIRequest
-	 * @throws {Error} Throws an error if the APIRequest instantiation or send operation fails
+	 * @returns {Promise<{success: boolean, statusCode: number, body: Object|string|null, headers: Object}>} Response object from the ApiRequest
+	 * 
+	 * @private
 	 * 
 	 * @example
 	 * // Internal usage (not typically called directly)
@@ -305,12 +328,12 @@ class Endpoint {
 		var response = null;
 
 		try {
-			var apiRequest = new tools.APIRequest(this.request);
+			var apiRequest = new ApiRequest(this.request);
 			response = await apiRequest.send();
 
 		} catch (error) {
-			tools.DebugAndLog.error(`Error in call (${this.request.note}): ${error.message}`, error.stack);
-			response = tools.APIRequest.responseFormat(false, 500, "Error in call()");
+			DebugAndLog.error(`Error in call (${this.request.note}): ${error.message}`, error.stack);
+			response = ApiRequest.responseFormat(false, 500, "Error in call()");
 		}
 
 		return response;
@@ -319,7 +342,14 @@ class Endpoint {
 
 };
 
+/**
+ * @module dao-endpoint
+ * @description Provides endpoint request functionality for making HTTP requests
+ */
 module.exports = {
-	getDataDirectFromURI: get, // deprecated alias
-	get
+	/** @deprecated Use send() instead */
+	getDataDirectFromURI,
+	/** @deprecated Use send() instead */
+	get,
+	send
 };

package/src/lib/tools/AWS.classes.js

@@ -17,7 +17,17 @@ const isTrue = (value) => {
  */
 const USE_XRAY = isTrue(process.env?.CacheData_AWSXRayOn) || isTrue(process.env?.CACHE_DATA_AWS_X_RAY_ON);
 
+/**
+ * X-Ray object if it is enabled
+ * @returns {object|null} The AWSXRay object if enabled and initialized, null otherwise
+ */
 let AWSXRay = null;
+
+/**
+ * Whether or not X-Ray is initialized
+ * @private
+ * @returns {object|null} The AWSXRay object if enabled and initialized, null otherwise
+ */
 let xrayInitialized = false;
 
 const initializeXRay = () => {
@@ -278,9 +288,25 @@ class AWS {
 			}
 		}
 	)();
-	
+		
 	/**
-	 * @returns {object} DynamoDB Document Client and functions for put, get, scan, delete, update
+	 * Provides a DynamoDB client and helper functions.
+	 *
+	 * @returns {{
+	 *   client: object,
+	 *   put: {(params:Object) => Promise<any>},
+	 *   get: {(params:Object) => Promise<any>},
+	 *   scan: {(params:Object) => Promise<any>},
+	 *   delete: {(params:Object) => Promise<any>},
+	 *   update: {(params:Object) => Promise<any>},
+	 *   sdk: {
+	 *     DynamoDB: object,
+	 *     DynamoDBClient: object,
+	 *     DynamoDBDocumentClient: object,
+	 *     GetCommand: object,
+	 *     PutCommand: object
+	 *   }
+	 * }}
 	 */
 	static get dynamo() {
 		return {
@@ -295,7 +321,18 @@ class AWS {
 	}
 
 	/**
-	 * @returns {object} S3 Client and functions for put, get
+	 * Provides a S3 client and helper functions.
+	 *
+	 * @returns {{
+	 *   client: object,
+	 *   put: {(params:Object) => Promise<any>},
+	 *   get: {(params:Object) => Promise<any>},
+	 *   sdk: {
+	 *     S3: object,
+	 *     GetObjectCommand: object,
+	 *     PutObjectCommand: object
+	 *   }
+	 * }}
 	 */
 	static get s3() {
 		return {
@@ -307,7 +344,18 @@ class AWS {
 	}
 
 	/**
-	 * @returns {object} SSM Client and functions for getByName, getByPath
+	 * Provides a SSM client and helper functions.
+	 *
+	 * @returns {{
+	 *   client: object,
+	 *   getByName: {(query:Object) => Promise<any>},
+	 *   getByPath: {(query:Object) => Promise<any>},
+	 *   sdk: {
+	 *     SSMClient: object,
+	 *     GetParametersByPathCommand: object,
+	 *     GetParametersCommand: object
+	 *   }
+	 * }}
 	 */
 	static get ssm() {
 		return {
@@ -327,4 +375,9 @@ class AWS {
 
 };
 
-module.exports = {AWS, AWSXRay};
+module.exports = {
+	AWS,
+	Aws: AWS, // alias
+	AWSXRay,
+	AwsXRay: AWSXRay, // alias
+};