@cocreate/api 1.20.4 → 1.20.6

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [1.20.6](https://github.com/CoCreate-app/CoCreate-api/compare/v1.20.5...v1.20.6) (2024-04-29)
+
+
+### Bug Fixes
+
+* bump cocreate dependencies ([28dabef](https://github.com/CoCreate-app/CoCreate-api/commit/28dabefd52299a59fc7cbe1fe6fbe1d15c074479))
+
+## [1.20.5](https://github.com/CoCreate-app/CoCreate-api/compare/v1.20.4...v1.20.5) (2024-04-27)
+
+
+### Bug Fixes
+
+* bug in param handeling ([083b77e](https://github.com/CoCreate-app/CoCreate-api/commit/083b77eebec53f5523fd228ccfb1a88911e6132b))
+* handeling of params ([9685e08](https://github.com/CoCreate-app/CoCreate-api/commit/9685e080d0bd0f3940aab9a7f277324c00526750))
+
 ## [1.20.4](https://github.com/CoCreate-app/CoCreate-api/compare/v1.20.3...v1.20.4) (2024-02-18)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cocreate/api",
-  "version": "1.20.4",
+  "version": "1.20.6",
   "description": "A simple api helper component in vanilla javascript used by JavaScript developers to create thirdparty api intergrations. CoCreate-api includes the client component and server side for api processing. Thirdparty apis can be accessible using HTML5 attributes and/or JavaScript API. ",
   "keywords": [
     "thirdparty-api-intergration",
@@ -59,11 +59,11 @@
     "webpack-log": "^3.0.1"
   },
   "dependencies": {
-    "@cocreate/actions": "^1.15.1",
-    "@cocreate/crud-client": "^1.32.2",
-    "@cocreate/element-prototype": "^1.15.0",
-    "@cocreate/render": "^1.37.1",
-    "@cocreate/socket-client": "^1.36.1",
-    "@cocreate/utils": "^1.30.0"
+    "@cocreate/actions": "^1.18.1",
+    "@cocreate/crud-client": "^1.33.8",
+    "@cocreate/element-prototype": "^1.22.2",
+    "@cocreate/render": "^1.40.3",
+    "@cocreate/socket-client": "^1.39.0",
+    "@cocreate/utils": "^1.33.6"
   }
 }

package/src/index.js

@@ -124,9 +124,38 @@ const CoCreateApi = {
         Socket.send({ method: name + '.' + method, [name]: data, broadcast: false, broadcastBrowser: false, status: 'await' });
     },
 
-    // TODO: handle $param operator
+    /**
+     * TODO: Implement Enhanced API Configuration Handling
+     * 
+     * Description:
+     * - Implement functionality to dynamically handle API configurations, supporting both complete and base URL endpoints with automatic method-based path appending.
+     * - Enable dynamic generation of query parameters from a designated object (`stripe` in the examples) when `query` is true.
+     * 
+     * Requirements:
+     * 1. Dynamic Endpoint Handling:
+     *    - Check if the endpoint configuration is a complete URL or a base URL.
+     *    - If the `method` derived path is not already included in the endpoint, append it dynamically.
+     *    Example:
+     *    `{ "method": "stripe.accounts.retrieve", "endpoint": "https://api.stripe.com", "query": true, "stripe": { "acct": "acct_123", "name": "John Doe" } }`
+     *    `{ "method": "stripe.accounts.retrieve", "endpoint": "https://api.stripe.com/accounts/retrieve", "query": true, "stripe": { "acct": "acct_123", "name": "John Doe" } }`
+     *    - Develop logic to parse the `method` and check against the endpoint. If necessary, append the appropriate API method segment.
+     * 
+     * 2. Query Parameter Handling:
+     *    - Dynamically construct and append query parameters from the `stripe` object if `query` is true. Ensure proper URL-encoding of keys and values.
+     * 
+     * 3. Security:
+     *    - Use the `method` for permission checks, ensuring that each API request complies with security protocols.
+     * 
+     * 4. Testing:
+     *    - Test both scenarios where the endpoint may or may not include the method path to ensure the dynamic construction works correctly.
+     *    - Ensure that all query parameters are correctly formatted and appended.
+     * 
+     * Notes:
+     * - Consider utility functions for parsing and modifying URLs, as well as for encoding parameters.
+     * - Maintain clear and detailed documentation for each part of the implementation to assist future development and troubleshooting.
+     */
     getData: async function ({ name, method, element, form }) {
-        const data = {}
+        let data = {}
 
         if (!form && element)
             form = element.closest('form');
@@ -146,10 +175,23 @@ const CoCreateApi = {
             }
         }
 
-        return dotNotationToObject(data);
+        let params = {}, hasParams = false
+        for (let i = 0; true; i++) {
+            if (`$param[${i}]` in data) {
+                params[`$param[${i}]`] = data[`$param[${i}]`]
+                delete data[`$param[${i}]`]
+                hasParams = true
+            } else {
+                break;
+            }
+        }
+        data = dotNotationToObject(data);
+        if (hasParams)
+            data = { ...params, ...data }
+
+        return data
     },
 
-    // TODO: handle $param operator
     setData: function ({ name, method, data, form }) {
         if (!form)
             form = document;