Merge pull request #1 from comwrap/saas

Saas compatibility

Author: nuzil

ExtensionRegistration.js

@@ -17,15 +17,12 @@ To required environment add:
 * I/O Events
 
 
-### Adobe Api Mesh
+### Adobe Api Mesh (Optional)
 
 1. Add "Api Mesh" service to your environment.
 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.
+    * AC-URL (This should be your Adobe Commerce system's base URL to GQL Endpoint)
 
 3. Provision Mesh by using this file with `aio api-mesh create adobe-api/mesh/mesh.json`.
 
@@ -39,19 +36,47 @@ To required environment add:
 Set following variables: 
 
 ```
-MESH_SOURCE_URL= // Your Mesh URL 
-AC_API_TOKEN= // Adobe Commerce Integration Bearer Token
+AC_GRAPHQL_URL= // Your GraphQL URL 
 AC_DEFAULT_STORE_CODE= // Default Adobe Commerce Store Code
+AC_ENVIRONMENT_ID= // Your Environment ID for Catalog Service if used (optional)
+```
+
+6. Configure Adobe Commerce Authorization
+
+In env.dist file you will find set of Auth parameters.
+
+**For Adobe Commerce PaaS:**
+
+These values can be copied from the Integration Details under System > Integrations in your Adobe Commerce backend
+
+```
+COMMERCE_CONSUMER_KEY=
+COMMERCE_CONSUMER_SECRET=
+COMMERCE_ACCESS_TOKEN=
+COMMERCE_ACCESS_TOKEN_SECRET=
+```
+
+**For Adobe Commerce SaaS:**
+
+Documentation how to get these values is available here: https://developer.adobe.com/developer-console/docs/guides/authentication/ServerToServerAuthentication/implementation
+
+```
+OAUTH_CLIENT_ID=
+OAUTH_CLIENT_SECRET=
+OAUTH_TECHNICAL_ACCOUNT_ID=
+OAUTH_TECHNICAL_ACCOUNT_EMAIL=
+OAUTH_ORG_ID=
+OAUTH_SCOPES=AdobeID, openid, read_organizations, additional_info.projectedProductContext, additional_info.roles, adobeio_api, read_client_secret, manage_client_secrets, event_receiver_api
 ```
 
-6. Create Event Provider for Feed Generator. Run `aio event provider create` and define name. Copy `id` from output.
+7. Create Event Provider for Feed Generator. Run `aio event provider create` and define name. Copy `id` from output.
 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. 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. 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. 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. 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.
+11. 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,6 +4,8 @@ Feed Generator is a service that simplifies the process of generating product fe
 
 ## Installation
 
+Module compartible with both Adobe Commerce SaaS and PaaS.
+
 Please see [INSTALL.md](INSTALL.md) for more details.
 
 ## Home page / Grid
@@ -97,8 +99,24 @@ Based on this GQL schema you can use the following variables (starting inside of
 * {{description.html}}
 * {{price_range.minimum_price.regular_price.value}}
 * {{price_range.minimum_price.regular_price.currency}}
+* {{SimpleProduct||weight}}
+
+SimpleProduct||** definition will be decoded like: 
+
+```graphql
+  products(search: "Motiv") {
+    items {
+      ... on SimpleProduct {
+        weight
+      }
+    }
+  }
+```
 
-… and so on depends on a schema used
+… and so on depends on a schema used.
+
+[!NOTE]
+In case you do not see some fields in autocompletion, it may be because your Schema has some custom or complex attributes. You can always enter them manually, and we would be happy to hear from you to add them to a future release.
 
 ### Filtering
 
@@ -179,7 +197,7 @@ Header and Footer currently have a support to variables (Only 1 actualy)
 
 ### Dynamic variables
 
-Variables are defined using double curly braces (`{{ }}`) and correspond to fields in the Magento GraphQL product output. For example, `{{sku}}` will be replaced with the product's SKU.
+Variables are defined using double curly braces (`{{ }}`) and correspond to fields in the Adobe Commerce GraphQL product output. For example, `{{sku}}` will be replaced with the product's SKU.
 
 ##### Additonal parameters
 
@@ -188,17 +206,26 @@ Variables are defined using double curly braces (`{{ }}`) and correspond to fiel
 When a variable corresponds to an array, you can use the `count` property to repeat the XML tag for each element in the array. For instance, using `count=5` will generate up to 5 tags, each containing a different value from the array.
 
 ```xml
-<g:brand count=5>{{manufacturer}}</g:brand>
+<g:brand>{{manufacturer count="5"}}</g:brand>
 ```
 
 ##### Selecting Specific Array Elements with `index`
 
 To select a specific element from an array, use the `index` property. This will generate a single tag with the value of the specified element from the array.
 
 ```xml
-<g:product_type index=2>{{categories.name}}</g:product_type>
+<g:product_type>{{categories.name index="2"}}</g:product_type>
+```
+
+##### Selecting Attribute with Specific code
+
+```xml
+<color>{{attributes.value code='color'}}</color>
 ```
 
+Add attributes.value is an Array of attributes, to get specific attribute, you can use "code" parameter and define attribute with which code you want to use.
+
+
 #### Example 
 
 ```xml
@@ -254,12 +281,14 @@ Regenerate Feed - will trigger the event “generate.feed” for a particular fe
 
   Action will be invoked when `feed.generate` event added.
 
-* `getGqlSchema` - retrieve graphql schema from target magento app.
+* `getGqlSchema` - retrieve graphql schema from target Adobe Commerce.
 
-* `getAllStores` - get all Magento stores by API
+* `getAllStores` - get all Adobe Commerce Stores by API
 
 * `generateByCron` - trigger feed generation by OpenWisk alarms. 
 
+* `getConfig` - receive public module configs. Currently only return type of authorization (ims vs oauth). 
+
 Action is running every 30 minutes and checking by feed settings if it have to be regenerate. Process regeneration if necessary.
 
 ### Web elements
@@ -281,7 +310,7 @@ Action is running every 30 minutes and checking by feed settings if it have to b
   * Feed Item: Big text field to have XML | JSON there with feed item body
   * Feed Header
   * Feed Footer
-  * Store View - select with list of available store views on Magento (websites also have to be there, but it is not possible to select them)
+  * Store View - select with list of available store views on Adobe Commerce (websites also have to be there, but it is not possible to select them)
 
   After saving the form, it saved into key/value storage and user have to be redirected to dashboard. Success message have to be shown there.
 

README.md

@@ -1,30 +1,21 @@
 {
   "meshConfig": {
     "sources": [
-      {
-        "name": "REST",
-        "handler": {
-          "openapi": {
-            "source": "MAGENTO-URL/rest/schema?services=storeStoreRepositoryV1,storeGroupRepositoryV1,storeWebsiteRepositoryV1",
-            "schemaHeaders": {
-              "Authorization": "Bearer MAGENTO-TOKEN"
-            },
-            "operationHeaders": {
-              "Authorization": "Bearer {context.headers['m-ac-rest-api-token']}",
-              "Content-Type": "application/json"
-            },
-            "includeHttpDetails": true
-          }
-        }
-      },
       {
         "name": "GraphQL",
         "handler": {
           "graphql": {
-            "endpoint": "MAGENTO-URL/graphql",
+            "endpoint": "AC-URL/graphql",
             "operationHeaders": {
-              "store": "{context.headers['m-ac-gql-store-code']}",
-              "Content-Type": "application/json"
+              "Content-Type": "application/json",
+              "Magento-Environment-Id": "{context.headers['Magento-Environment-Id']}",
+              "Magento-Website-Code": "{context.headers['Magento-Website-Code']}",
+              "Magento-Store-View-Code": "{context.headers['Magento-Store-View-Code']}",
+              "Magento-Store-Code": "{context.headers['Magento-Store-Code']}",
+              "Magento-Customer-Group": "{context.headers['Magento-Customer-Group']}",
+              "x-api-key": "{context.headers['x-api-key']}",
+              "Authorization": "{context.headers['Authorization']}",
+              "store": "{context.headers['store']}"
             }
           }
         }

actions/meshGql.js

@@ -1,94 +1,7 @@
-application:
-  actions: actions
-  web: web-src
-  runtimeManifest:
-    packages:
-      feed-generator:
-        license: Apache-2.0
-        inputs:
-          LOG_LEVEL: debug
-          apiKey: $SERVICE_API_KEY
-          mesh_source_url: $MESH_SOURCE_URL
-          m-ac-rest-api-token: $AC_API_TOKEN
-          m-ac-gql-store-code: $AC_DEFAULT_STORE_CODE
-        actions:
-          saveFeed:
-            function: actions/saveFeed/index.js
-            web: 'yes'
-            runtime: nodejs:20
-            annotations:
-              require-adobe-auth: true
-              final: true
-          deleteFeed:
-            function: actions/deleteFeed/index.js
-            web: 'yes'
-            runtime: nodejs:20
-            annotations:
-              require-adobe-auth: true
-              final: true
-          getAllFeeds:
-            function: actions/getAllFeeds/index.js
-            web: 'yes'
-            runtime: nodejs:20
-            annotations:
-              require-adobe-auth: true
-              final: true
-          getFeedByUuid:
-            function: actions/getAllFeeds/getByUuid.js
-            web: 'yes'
-            runtime: nodejs:20
-            annotations:
-              require-adobe-auth: true
-              final: true
-          regenerateFeed:
-            function: actions/regenerateFeed/index.js
-            web: 'yes'
-            runtime: nodejs:20
-            inputs:
-              providerId: $FEED_GENERATOR_PROVIDER_ID
-              eventCode: feed.generate
-            annotations:
-              require-adobe-auth: true
-              final: true
-          processGeneration:
-            function: actions/regenerateFeed/generate.js
-            web: 'no'
-            runtime: nodejs:20
-            inputs:
-              eventCode: feed.generate
-            annotations:
-              require-adobe-auth: false
-              final: true
-            relations:
-              event-listener-for:
-                - feed.generate
-          generateByCron:
-            function: actions/regenerateFeed/generateByCron.js
-            web: 'no'
-            runtime: nodejs:20
-            annotations:
-              require-adobe-auth: false
-              final: true
-          getAllStores:
-            function: actions/magentoActions/getAllStores.js
-            web: 'yes'
-            runtime: nodejs:20
-            annotations:
-              require-adobe-auth: true
-              final: true
-          getGqlSchema:
-            function: actions/magentoActions/getGqlSchema.js
-            web: 'yes'
-            runtime: nodejs:20
-            annotations:
-              require-adobe-auth: true
-              final: true
-        triggers:
-          everyHalfOfHour:
-            feed: /whisk.system/alarms/interval
-            inputs:
-              minutes: 30
-        rules:
-          everyHalfOfHourRule:
-            trigger: everyHalfOfHour
-            action: generateByCron
+extensions:
+  commerce/backend-ui/1:
+    $include: src/commerce-backend-ui-1/ext.config.yaml  
+productDependencies:
+  - code: COMMC
+    minVersion: 2.4.5
+    maxVersion: 3.0.0

adobe-api/mesh/mesh.json.dist

@@ -0,0 +1,35 @@
+# Your Adobe Commerce GraphQL URL / OR Mesh URL
+AC_GRAPHQL_URL=
+# Your system Environment ID for Catalog Service OR Tennant ID of SaaS (optional, for SaaS or for Catalog Service endpoints)
+AC_ENVIRONMENT_ID=
+
+# Default Store to use for default setup
+AC_DEFAULT_STORE_CODE=default
+
+# Default Runtime Setup
+OAUTH_BASE_URL=https://ims-na1.adobelogin.com/ims/token/
+IO_MANAGEMENT_BASE_URL=https://api.adobe.io/events/
+
+# Event provider for feed generation
+FEED_GENERATOR_PROVIDER_ID=
+
+# Rest API URL. Commerce base URL should finish with slash '/'
+COMMERCE_BASE_URL=
+
+
+# Commerce OAuth configs
+# These values can be copied from the Integration Details under System > Integrations
+COMMERCE_CONSUMER_KEY=
+COMMERCE_CONSUMER_SECRET=
+COMMERCE_ACCESS_TOKEN=
+COMMERCE_ACCESS_TOKEN_SECRET=
+
+# OAuth configs for SaaS (IMS)
+## More info: https://developer.adobe.com/developer-console/docs/guides/authentication/ServerToServerAuthentication/implementation
+
+OAUTH_CLIENT_ID=
+OAUTH_CLIENT_SECRET=
+OAUTH_TECHNICAL_ACCOUNT_ID=
+OAUTH_TECHNICAL_ACCOUNT_EMAIL=
+OAUTH_ORG_ID=
+OAUTH_SCOPES=AdobeID, openid, read_organizations, additional_info.projectedProductContext, additional_info.roles, adobeio_api, read_client_secret, manage_client_secrets, event_receiver_api