Cleanup and update of packages

Author: nuzil

.gitignore

@@ -41,5 +41,4 @@ coverage
 # logs folder for aio-run-detached
 logs
 
-app.config.yaml
 adobe-api/mesh/mesh.json

DEVELOPMENT.md

@@ -20,11 +20,14 @@ To required environment add:
 ### Adobe Api Mesh
 
 1. Add "Api Mesh" service to your environment.
-2. Rename file `adobe-api/mesh.json.dist` into `adobe-api/mesh.json`.
-3. Change required options inside `adobe-api/mesh.json`.
-    * MAGENTO-URL
-    * MAGENTO-TOKEN
-3. Provision Mesh by using this file.
+2. Rename file `adobe-api/mesh/mesh.json.dist` into `adobe-api/mesh/mesh.json`.
+3. Change required options inside `adobe-api/mesh/mesh.json`.
+    * MAGENTO-URL (This should be your Adobe Commerce system's base URL.)
+    * MAGENTO-TOKEN 
+
+    You can obtain the token by following these [steps](https://experienceleague.adobe.com/en/docs/commerce-admin/systems/integrations). Copy the Access Token value once generated. Additionally, you need to enable the "[Integration Token](https://experienceleague.adobe.com/en/docs/commerce-admin/systems/integrations)" functionality if it is not enabled yet. The generated token does not expire, but it can be updated if necessary.
+
+3. Provision Mesh by using this file with `aio api-mesh create adobe-api/mesh/mesh.json`.
 
 ## Installation
 
@@ -46,9 +49,9 @@ Add to `.env` line `FEED_GENERATOR_PROVIDER_ID=<id>`
 
 7. Create Event Metadata for Feed Generator. Run `aio event eventmetadata create PROVIDERID`. Define event code as `feed.generate` and define description as `Generate Feed`.
 
-8. Go To your application environment via Browser. Click on "Add Service" -> Event -> 3rd Party Custom Events -> And select your provider and event subscription. In Receiver define "Runtime action" as `processGeneration` action.
+8. Run `aio app deploy` to deploy the app.
 
-9. Run `aio app deploy` to deploy the app.
+9. Go To your application environment via Browser. Click on "Add Service" -> Event -> 3rd Party Custom Events -> And select your provider and event subscription. In Receiver define "Runtime action" as `processGeneration` action.
 
-10. App is ready to use. Pls save the link to your application environment. Additionally you can replacate all steps on your Production environment and publich application, so it will be available on your exchange dashboard.
+10. The app is ready to use. Please save the link to your application environment. Additionally, you can replicate all steps in your production environment and publish the application, so it will be available on your exchange dashboard.
 

INSTALL.md

@@ -4,7 +4,7 @@ Feed Generator is a service that simplifies the process of generating product fe
 
 ## Installation
 
-Pls see [INSTALL.md](INSTALL.md) for more details.
+Please see [INSTALL.md](INSTALL.md) for more details.
 
 ## Home page / Grid
 
@@ -60,7 +60,7 @@ Here you can change the following elements:
 
 ### Feed Body
 
-For feed body variables can be used. Variables are representing GQL schem that being used (by default it is a Adobe Commerce schema).
+Variables can be used for the feed body. These variables represent the GraphQL schema being used (by default, it is the Adobe Commerce schema).
 
 Example:
 
@@ -100,6 +100,68 @@ Based on this GQL schema you can use the following variables (starting inside of
 
 … and so on depends on a schema used
 
+### Filtering
+
+Without applying filters, the system will attempt to fetch all available products for the selected store. To narrow down the selection, you can apply custom filters.
+
+![Filtering](./docs/images/feed-filtering.png)
+
+#### Search
+
+In the search field, you can enter any search term, and it will be applied to the GraphQL "products" query as a search parameter. 
+
+```
+query {
+  products(
+    search:"Tank"
+  ) {
+    items {
+      sku
+      name
+  }
+}
+```
+
+#### Filter Configuration
+
+If you want to apply GraphQL filters, you can paste JSON that will be converted into a standard GraphQL filter. 
+
+As example, from 
+
+```
+{
+  "category_id": {
+    "eq": "26"
+  }
+}
+```
+
+to
+
+```
+ query {
+  products(
+    filter: { category_id: { eq: "26" } }
+  ) {
+    items {
+      sku
+      name
+  }
+}
+```
+
+### Scheduling
+
+You can configure how often feed can be updated.
+
+In "Manual" mode, feed will be updated only by clicking "Regenerate Feed"
+
+![Manual mode](./docs/images/feed-schedule-manual.png)
+
+In "By Schedule" mode, feed will be automatically updated at defined time.
+
+![Scheduled mode](./docs/images/feed-schedule-auto.png)
+
 ## Settings
 
 GraphQL schema loaded from Adobe Commerce is cached by the module. So if you change schema on Adobe Commerce side, you have to update the cache.
@@ -163,7 +225,7 @@ To select a specific element from an array, use the `index` property. This will
 
 Delete Feed - deleting current feed from the database and from all schedules
 
-Regenerate Feed - will fire event “generate.feed“ for particular feed ID. And this event will triggen and action that will create new feed.
+Regenerate Feed - will trigger the event “generate.feed” for a particular feed ID. This event will initiate an action that creates a new feed.
 
 ### app.config.yaml
 

README.md

@@ -1,7 +1,7 @@
 const {callMeshGql} = require("./../meshGql.js");
 
 async function queryProducts (gqlRequest, params, variables = {}) {
-  let products = await callMeshGql(gqlRequest, params, variables = {})
+  let products = await callMeshGql(gqlRequest, params, variables)
   return products
 }
 

actions/acGql.js.DEPRECATED

@@ -1,6 +1,5 @@
-const {getIntrospectionQuery, buildClientSchema} = require("graphql");
+const {getIntrospectionQuery} = require("graphql");
 const {errorResponse} = require("./../utils.js");
-const fetch = require('node-fetch')
 
 /**
  * Return GQL schema or throw error
@@ -12,7 +11,7 @@ async function getSchema(params) {
   const gqlUrl = params['mesh_source_url']
 
   const introspectionQuery = getIntrospectionQuery();
-  let tty = JSON.stringify({query: introspectionQuery});
+
   const result = await fetch(gqlUrl, {
     method: 'POST',
     headers: {

actions/acGqlLib/products.js

@@ -1,8 +1,6 @@
-const {v4: uuidv4} = require('uuid');
-const fetch = require('node-fetch')
 const {Core} = require('@adobe/aio-sdk')
 const stateLib = require('@adobe/aio-lib-state')
-const {errorResponse, getBearerToken, stringParameters, checkMissingRequestInputs} = require('./../utils.js')
+const {errorResponse} = require('./../utils.js')
 
 // delete feed by uuid
 async function main(params) {
@@ -20,17 +18,17 @@ async function main(params) {
         if (uuid === null || typeof uuid == 'undefined' || uuid == 'undefined' || uuid == undefined) {
             return responseData
         }
-        const [deleteResult, feedsInformation] = await Promise.all([
-            state.delete('feeds_' + uuid),
-            state.get('feeds_list') || {"value": {}}
-        ])
+        
+        let feedsInformation = await state.get('feeds_list') || {"value": "{}"};
+
+        await state.delete('feeds_' + uuid);
 
         // remove uuid from feed list
-        const feedsList = feedsInformation['value']
+        const feedsList = JSON.parse(feedsInformation['value'])
         const indexToRemove = Object.values(feedsList).indexOf(uuid);
         if (indexToRemove > -1) {
             delete feedsList[indexToRemove];
-            await state.put('feeds_list', feedsList, { ttl: -1 });
+            await state.put('feeds_list', JSON.stringify(feedsList), { ttl: stateLib.MAX_TTL });
         }
 
         return responseData

actions/acGqlLib/schema.js

@@ -1,8 +1,6 @@
-const { v4: uuidv4 } = require('uuid');
-const fetch = require('node-fetch')
 const { Core } = require('@adobe/aio-sdk')
 const stateLib = require('@adobe/aio-lib-state')
-const { errorResponse, getBearerToken, stringParameters, checkMissingRequestInputs } = require('./../utils.js')
+const { errorResponse } = require('./../utils.js')
 
 // main function that will be executed by Adobe I/O Runtime
 async function main (params) {
@@ -12,15 +10,18 @@ async function main (params) {
   try {
     const state = await stateLib.init()
     const uuid = params.uuid  
-    let feedInformation = await state.get('feeds_' + uuid) || 0
 
-    if (feedInformation === 0) {
-      feedInformation = {}
+    let feedsInformation = await state.get('feeds_' + uuid) || 0;
+
+    if (feedsInformation === 0) {
+      feedsInformation = {}
+    } else {
+      feedsInformation['value'] = JSON.parse(feedsInformation['value']);
     }
 
     const response = {
       statusCode: 200,
-      body: feedInformation
+      body: feedsInformation
     }
     return response