@cocreate/api 1.20.6 → 1.21.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.21.0](https://github.com/CoCreate-app/CoCreate-api/compare/v1.20.6...v1.21.0) (2024-05-19)
+
+
+### Features
+
+* attributes to handle endpoint and query ([f6aa450](https://github.com/CoCreate-app/CoCreate-api/commit/f6aa4502147e5ef9e6f6d24daf326de14829b710))
+
 ## [1.20.6](https://github.com/CoCreate-app/CoCreate-api/compare/v1.20.5...v1.20.6) (2024-04-29)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cocreate/api",
-  "version": "1.20.6",
+  "version": "1.21.0",
   "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",

package/src/index.js

@@ -124,36 +124,6 @@ const CoCreateApi = {
         Socket.send({ method: name + '.' + method, [name]: data, broadcast: false, broadcastBrowser: false, status: 'await' });
     },
 
-    /**
-     * 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 }) {
         let data = {}
 
@@ -173,6 +143,15 @@ const CoCreateApi = {
             if (key) {
                 data[key] = await elements[i].getValue()
             }
+
+            let endpoint = elements[i].getAttribute('endpoint')
+            if (endpoint) {
+                data.endpoint = endpoint
+            }
+
+            if (elements[i].getAttribute('query') && elements[i].getAttribute('query') !== 'false') {
+                data.query = true
+            }
         }
 
         let params = {}, hasParams = false
@@ -215,8 +194,12 @@ const CoCreateApi = {
                     });
                 } else {
                     let key = elements[i].getAttribute(`${name}-key`)
-                    let value = getValueFromObject(data[name], key);
-                    elements[i].setValue(value);
+                    if (key === '{}')
+                        elements[i].setValue(data[name])
+                    else {
+                        let value = getValueFromObject(data[name], key);
+                        elements[i].setValue(value);
+                    }
                 }
             }
         }