INT-340: Add Atlas AI support

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 ## Unreleased
+### Add
+- Add support for Atlas AI
+
 ### Change
 - Upgrade Web Components version to v5.3.0
 

README.md

@@ -137,6 +137,7 @@ Note: Sending each request to FACT-Finder instance trough Shopware, you lose on
 * Add cart button - select this option if you want the Add to cart button on the product list
 * Scenario how to count single click on "Add to cart" button
 * Redirect mapping for selected queries - put each pair `query=url` in separate row. If the phrase appears twice, the first one from the top of the list will be taken. Url can be relative path `/some/page` or absolute url `https://domain.com/some/page?someParameter=1`. If provided pair has an invalid format then it will be ignored.
+* Atlas AI support - If Atlas AI support is enabled, the integration handles Atlas AI-specific requirements automatically. This includes creating a dedicated Atlas AI user ID and storing it on the client side across sessions. **Important: If you enable this function, userId will be generated automatically and the previous values for userId that were sent for logged-in users will be overwritten.**
 
 #### Server Side Rendering
 That option enables Server Side Rendering (SSR) for `ff-record-list` element on category and search result pages.

spec/Subscriber/ConfigurationSubscriberSpec.php

@@ -69,6 +69,7 @@ public function it_will_return_factfinderchannel_for_specific_sales_channel_id(
         $communication->isSsrActive()->willReturn(false);
         $communication->isProxyEnabled()->willReturn(false);
         $communication->isCartBtnEnabled()->willReturn(false);
+        $communication->supportAtlasAi()->willReturn(false);
         $communication->getFactFinderFeatures()->willReturn([]);
         $communication->getChannel('main_sales_channel')->willReturn('some_ff_channel');
         $communication->getFieldRoles(Argument::any())->willReturn([]);
@@ -117,6 +118,7 @@ public function it_will_add_page_extension_for_storefront_render_event(
         $communication->isSsrActive()->willReturn(false);
         $communication->isProxyEnabled()->willReturn(false);
         $communication->isCartBtnEnabled()->willReturn(false);
+        $communication->supportAtlasAi()->willReturn(false);
         $event->getRequest()->willReturn($request);
         $request->get('_route', Argument::any())->willReturn('factfinder');
         $request->getLocale()->willReturn('en');
@@ -160,6 +162,7 @@ public function it_will_throw_exception_when_event_does_not_have_page(
         $communication->isSsrActive()->willReturn(false);
         $communication->isProxyEnabled()->willReturn(false);
         $communication->isCartBtnEnabled()->willReturn(false);
+        $communication->supportAtlasAi()->willReturn(false);
         $event->getRequest()->willReturn($request);
         $request->get('_route', Argument::any())->willReturn('factfinder');
         $request->getLocale()->willReturn('en');

src/Config/Communication.php

@@ -71,6 +71,11 @@ public function isCartBtnEnabled(): bool
         return (bool) $this->config('addCartBtn');
     }
 
+    public function supportAtlasAi(): bool
+    {
+        return (bool) $this->config('atlasAiSupport');
+    }
+
     public function getFactFinderFeatures(): array
     {
         return [

src/Resources/config/config.xml

@@ -78,6 +78,15 @@
             <defaultValue>false</defaultValue>
         </input-field>
 
+        <input-field type="bool">
+            <name>atlasAiSupport</name>
+            <label>Atlas AI support</label>
+            <label lang="de-DE">Atlas AI-Unterstützung</label>
+            <defaultValue>false</defaultValue>
+            <helpText>If Atlas AI support is enabled, the integration handles Atlas AI-specific requirements automatically. This includes creating a dedicated Atlas AI user ID and storing it on the client side across sessions. Important: If you enable this function, userId will be generated automatically and the previous values for userId that were sent for logged in users will be overwritten.</helpText>
+            <helpText lang="de-DE">Wenn die Atlas AI-Unterstützung aktiviert ist, kümmert sich die Integration automatisch um die Atlas AI-spezifischen Anforderungen. Dazu gehört die Erstellung einer dedizierten Atlas AI-Benutzer-ID und deren clientseitige Speicherung über mehrere Sitzungen hinweg. Wichtig: Wenn Sie diese Funktion aktivieren, wird die Benutzer-ID automatisch generiert und die zuvor für angemeldete Benutzer gesendeten Werte werden überschrieben.</helpText>
+        </input-field>
+
         <input-field type="single-select">
             <name>trackingAddToCartCount</name>
             <options>

src/Resources/views/storefront/base.html.twig

@@ -16,17 +16,17 @@
                 apiKey: `{{page.extensions.factfinder.communication.apiKey}}`,
               },
               appConfig: {
-                debug: true,
+                atlasAiMode: {{page.extensions.factfinder.communication.supportAtlasAi ? 'true' : 'false'}},
                 fieldRoles: {{ page.extensions.factfinder.field_roles|json_encode|raw }},
                 formatting: {
                   locale: `{{page.extensions.factfinder.communication.currencyCountryCode}}`,
                   formatOptions: {
                     style: `currency`,
                     currency: `{{page.extensions.factfinder.communication.currencyCode}}`,
+                  },
+                },
               },
-            },
-          },
-          });
+            });
 
             const ffRedirectMapping = JSON.parse('{{ page.extensions.factfinder.redirectMapping|raw }}');
 

src/Subscriber/ConfigurationSubscriber.php

@@ -46,6 +46,7 @@ public function onPageLoaded(ShopwareSalesChannelEvent $event): void
             'apiKey'                => $this->config->getApiKey(),
             'currencyCode'          => $event->getSalesChannelContext()->getCurrency()->getIsoCode(),
             'currencyCountryCode'   => $event->getRequest()->getLocale(),
+            'supportAtlasAi'        => $this->config->supportAtlasAi(),
         ];
 
         if (!empty($this->configurationAddParams)) {