@cocreate/lazy-loader 1.19.3 → 1.20.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [1.20.0](https://github.com/CoCreate-app/CoCreate-lazy-loader/compare/v1.19.4...v1.20.0) (2024-05-19)
+
+
+### Features
+
+* $crud operator handles an array of objects ([1cd7205](https://github.com/CoCreate-app/CoCreate-lazy-loader/commit/1cd7205b8a021cc9e98edb74cc3df7575357fd6e))
+
+## [1.19.4](https://github.com/CoCreate-app/CoCreate-lazy-loader/compare/v1.19.3...v1.19.4) (2024-05-10)
+
+
+### Bug Fixes
+
+* removed environment handling variables as it is database specific ([d63921c](https://github.com/CoCreate-app/CoCreate-lazy-loader/commit/d63921cb039c284ab452bf47f0802fc56a66eeb3))
+
 ## [1.19.3](https://github.com/CoCreate-app/CoCreate-lazy-loader/compare/v1.19.2...v1.19.3) (2024-05-08)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cocreate/lazy-loader",
-  "version": "1.19.3",
+  "version": "1.20.0",
   "description": "A simple lazy-loader component in vanilla javascript. Easily configured using HTML5 data-attributes and/or JavaScript API.",
   "keywords": [
     "lazy-loader",

package/src/server.js

@@ -150,23 +150,49 @@ class CoCreateLazyLoader {
         }
     }
 
+    /**
+     * 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.
+     */
+
     async api(config, data) {
         try {
             const methodPath = data.method.split('.')
             const name = methodPath.shift()
 
             const apis = await this.getApiKey(data, name)
-            let environment = 'production';
-
-            if (data.environment)
-                environment = data.environment
-            else if (data.host.startsWith('dev.') || data.host.startsWith('test.'))
-                environment = 'test'
 
-            const key = apis[environment].key;
+            const key = apis.key;
             if (!key)
                 throw new Error(`Missing ${name} key in organization apis object`);
 
+            // ToDo: if data.endpoint service not required as endpoint will be used
             const service = require(config.path);
             let instance
             if (config.initialize)
@@ -205,31 +231,25 @@ class CoCreateLazyLoader {
     async webhooks(config, data, name) {
         try {
             const apis = await this.getApiKey(data, name)
-            let environment = 'production';
-
-            if (data.environment)
-                environment = data.environment
-            else if (data.host.startsWith('dev.') || data.host.startsWith('test.'))
-                environment = 'test'
 
-            const key = apis[environment].key;
+            const key = apis.key;
             if (!key)
                 throw new Error(`Missing ${name} key in organization apis object`);
 
             let webhookName = data.req.url.split('/');
             webhookName = webhookName[webhookName.length - 1]
 
-            const webhook = apis[environment].webhooks[webhookName];
+            const webhook = apis.webhooks[webhookName];
             if (!webhook)
                 throw new Error(`Webhook ${name} ${webhookName} is not defined`);
 
             // eventDataKey is used to access the event data
-            let eventDataKey = webhook.eventDataKey || apis[environment].eventDataKey
+            let eventDataKey = webhook.eventDataKey || apis.eventDataKey
             if (!eventDataKey)
                 throw new Error(`Webhook ${name} eventKey is not defined`);
 
             // eventNameKey is used to access the event the event name
-            let eventNameKey = webhook.eventNameKey || apis[environment].eventNameKey
+            let eventNameKey = webhook.eventNameKey || apis.eventNameKey
             if (!eventNameKey)
                 throw new Error(`Webhook ${name} eventNameKey is not defined`);
 
@@ -254,15 +274,15 @@ class CoCreateLazyLoader {
 
             if (webhook.authenticate && webhook.authenticate.method) {
                 method = webhook.authenticate.method
-            } else if (apis[environment].authenticate && apis[environment].authenticate.method) {
-                method = apis[environment].authenticate.method
+            } else if (apis.authenticate && apis.authenticate.method) {
+                method = apis.authenticate.method
             } else
                 throw new Error(`Webhook ${name} authenticate method is not defined`);
 
             if (webhook.authenticate && webhook.authenticate.parameters) {
                 parameters = webhook.authenticate.parameters
-            } else if (apis[environment].authenticate && apis[environment].authenticate.parameters) {
-                parameters = apis[environment].authenticate.parameters
+            } else if (apis.authenticate && apis.authenticate.parameters) {
+                parameters = apis.authenticate.parameters
             } else
                 throw new Error(`Webhook ${name} authenticate parameters is not defined`);
 
@@ -349,11 +369,25 @@ class CoCreateLazyLoader {
         } else if (operator.startsWith('$rawBody')) {
             return getValueFromObject(data, operator.substring(1))
         } else if (operator.startsWith('$crud')) {
-            context = await this.processOperators(data, event, context);
-            result = await this.crud.send(context)
-            if (operator.startsWith('$crud.'))
-                result = getValueFromObject(operator, operator.substring(6))
-            return await this.processOperators(data, event, result);
+            let results = context
+            let isObject = false
+            if (!Array.isArray(results)) {
+                isObject = true
+                results = [results]
+            }
+
+            for (let i = 0; i < results.length; i++) {
+                results[i] = await this.processOperators(data, event, results[i]);
+                results[i] = await this.crud.send(results[i])
+                if (operator.startsWith('$crud.'))
+                    results[i] = getValueFromObject(operator, operator.substring(6))
+                results[i] = await this.processOperators(data, event, results[i])
+            }
+
+            if (isObject)
+                results = results[0]
+
+            return results;
         } else if (operator.startsWith('$socket')) {
             context = await this.processOperators(data, event, context);
             result = await this.socket.send(context)