@63klabs/cache-data 1.3.4 → 1.3.5

package/CHANGELOG.md

@@ -8,6 +8,19 @@ Report all vulnerabilities under the [Security menu](https://github.com/63Klabs/
 
 > Note: This project is still in beta. Even though changes are tested and breaking changes are avoided, things may break.
 
+## v1.3.5 (2025-01-13)
+
+### Enhancements
+
+- `endpoint.getDataDirectFromURI()` has been renamed to `endpoint.get()` and the old name is now a deprecated alias. This was just to simplify naming.
+
+Example Use:
+
+```javascript
+const { endpoint } = require("@63klabs/cache-data");
+const data = await endpoint.get({host: "api.example.com", path: "data"}, { parameters: {q: "Chicago" }});
+```
+
 ## v1.3.4 (2025-01-12)
 
 ### Fixes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@63klabs/cache-data",
-  "version": "1.3.4",
+  "version": "1.3.5",
   "description": "Cache data from an API endpoint or application process using AWS S3 and DynamoDb",
   "author": "Chad Leigh Kluck (https://chadkluck.me)",
   "license": "MIT",

package/src/lib/dao-endpoint.js

@@ -59,16 +59,19 @@ const tools = require("./tools/index.js");
 /**
  * 
  * @param {ConnectionObject} connection An object with details about the connection (method, uri, host, etc)
- * @param {*} data Additional data to perform a query for the request, or transformation of the response within the DAO object. This data is not directly sent to the endpoint. It is used within the DAO object to transform the request and/or response. Any data sent to the endpoint should be in the connection or handled within the DAO
- * @returns {object} The response
+ * @param {Object} query Additional data to perform a query for the request.
+ * @returns {Object} The response
+ * @example
+    const { endpoint } = require("@63klabs/cache-data");
+    const data = await endpoint.get({host: "api.example.com", path: "data"}, { parameters: {q: "Chicago" }});
  */
-const getDataDirectFromURI = async (connection, data = null) => {
-	return (new Endpoint(connection).get());
+const get = async (connection, query = null) => {
+	return (new Endpoint(connection, query).get());
 };
 
 /**
  * A bare bones request to an endpoint. Can be used as a template to
- * create more elaboarate requests. 
+ * create more elaborate requests. 
  */
 class Endpoint {
 
@@ -76,10 +79,21 @@ class Endpoint {
 	 * 
 	 * @param {ConnectionObject} connection An object with connection data
 	 */
-	constructor(connection) {
+	constructor(connection, query = {}) {
 
 		this.response = null;
 
+		// if query has parameters property then we will combine with connection parameters
+		if ( query !== null && "parameters" in query ) {
+			if ( !("parameters" in connection) || connection.parameters === null ) {
+				connection.parameters = {};
+			}
+			
+			for ( const [key, value] of Object.entries( query.parameters ) ) {
+				connection.parameters[key] = value;
+			}
+		}
+
 		this.request = {
 			method: this._setRequestSetting(connection, "method", "GET"),
 			uri: this._setRequestSetting(connection, "uri", ""),
@@ -182,5 +196,6 @@ class Endpoint {
 };
 
 module.exports = {
-	getDataDirectFromURI
+	getDataDirectFromURI: get, // deprecated alias
+	get
 };