Raptor integration - feature branch

code_samples/recommendations/EventData.php

@@ -0,0 +1,28 @@
+<?php declare(strict_types=1);
+
+namespace App\Tracking;
+
+use Ibexa\Contracts\ConnectorRaptor\Tracking\Event\VisitEventData;
+use Ibexa\Contracts\ConnectorRaptor\Tracking\ServerSideTrackingDispatcherInterface;
+use Ibexa\Contracts\ProductCatalog\Values\ProductInterface;
+
+class EventData
+{
+    public function __construct(
+        private readonly ServerSideTrackingDispatcherInterface $trackingDispatcher,
+    ) {
+    }
+
+    public function dispatchVisitEvent(ProductInterface $product): void
+    {
+        $eventData = new VisitEventData(
+            productCode: $product->getCode(),
+            productName: $product->getName(),
+            categoryPath: '25#Electronics;26#Smartphones',  // Build manually
+            currency: 'USD',
+            itemPrice: '999.99'
+        );
+
+        $this->trackingDispatcher->dispatch($eventData);
+    }
+}

code_samples/recommendations/EventMapper.php

@@ -0,0 +1,29 @@
+<?php declare(strict_types=1);
+
+namespace App\Tracking;
+
+use Ibexa\Contracts\ConnectorRaptor\Tracking\EventContext;
+use Ibexa\Contracts\ConnectorRaptor\Tracking\EventMapperInterface;
+use Ibexa\Contracts\ConnectorRaptor\Tracking\EventType;
+use Ibexa\Contracts\ConnectorRaptor\Tracking\ServerSideTrackingDispatcherInterface;
+use Ibexa\Contracts\ProductCatalog\Values\ProductInterface;
+
+class EventMapper
+{
+    public function __construct(
+        private readonly EventMapperInterface $eventMapper,
+        private readonly ServerSideTrackingDispatcherInterface $trackingDispatcher,
+    ) {
+    }
+
+    public function trackProductView(ProductInterface $product): void
+    {
+        // Map product to VisitEventData automatically, override its category
+        $eventData = $this->eventMapper->map(EventType::VISIT, $product, [
+            EventContext::CATEGORY_IDENTIFIER => 'electronics',
+        ]);
+
+        // Send tracking event
+        $this->trackingDispatcher->dispatch($eventData);
+    }
+}

code_samples/recommendations/EventSubscriber.php

@@ -0,0 +1,42 @@
+<?php declare(strict_types=1);
+
+namespace App\Tracking;
+
+use Ibexa\Contracts\ConnectorRaptor\Tracking\EventMapperInterface;
+use Ibexa\Contracts\ConnectorRaptor\Tracking\EventType;
+use Ibexa\Contracts\ConnectorRaptor\Tracking\ServerSideTrackingDispatcherInterface;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\ResponseEvent;
+use Symfony\Component\HttpKernel\KernelEvents;
+
+class EventSubscriber implements EventSubscriberInterface
+{
+    public function __construct(
+        private readonly EventMapperInterface $eventMapper,
+        private readonly ServerSideTrackingDispatcherInterface $trackingDispatcher,
+    ) {
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [KernelEvents::RESPONSE => ['onResponse', -10]];
+    }
+
+    public function onResponse(ResponseEvent $event): void
+    {
+        if (!$event->isMainRequest()) {
+            return;
+        }
+
+        $request = $event->getRequest();
+
+        // Example: track only if request has specific attribute
+        $product = $request->attributes->get('product');
+        if (null === $product) {
+            return;
+        }
+
+        $eventData = $this->eventMapper->map(EventType::VISIT, $product);
+        $this->trackingDispatcher->dispatch($eventData);
+    }
+}

code_samples/recommendations/config/packages/ibexa_connector_raptor.yaml

@@ -0,0 +1,16 @@
+ibexa:
+    system:
+        <scope>:
+            connector_raptor:
+                enabled:              true
+                customer_id:          ~ # Required
+                tracking_type:        client # One of: "client" or "server"
+
+                # Raptor Recommendations API key
+                recommendations_api_key: ~ # Required
+
+                # Raptor Recommendations API URL, optional, set by default
+                recommendations_api_url: '%ibexa.connector.raptor.recommendations.api_url%'
+ibexa_connector_raptor:
+    # When enabled, tracking exceptions are thrown instead of being silently handled
+    strict_exceptions: true

code_samples/recommendations/custom_integration.html

@@ -0,0 +1,31 @@
+``` html
+<!-- Cookie Consent by TermsFeed https://www.TermsFeed.com -->
+<script type="text/javascript" src="https://www.termsfeed.com/public/cookie-consent/4.2.0/cookie-consent.js" charset="UTF-8"></script>
+<script type="text/javascript" charset="UTF-8">
+    document.addEventListener('DOMContentLoaded', function () {
+        cookieconsent.run({
+            "notice_banner_type": "simple",
+            "consent_type": "implied",
+            "palette": "dark",
+            "language": "en",
+            "page_load_consent_levels": ["strictly-necessary"],
+            "notice_banner_reject_button_hide": false,
+            "preferences_center_close_button_hide": false,
+            "page_refresh_confirmation_buttons": false,
+            "website_name": "Ibexa Storefront",
+            "callbacks": {
+                "scripts_specific_loaded": (level) => {
+                    switch(level) {
+                        case 'tracking':
+                            document.dispatchEvent(new CustomEvent('enableTracking'));
+                            break;
+                    }
+                }
+            },
+            "callbacks_force": true
+        });
+    });
+</script>
+<noscript>Free cookie consent management tool by <a href="https://www.termsfeed.com/">TermsFeed</a></noscript>
+<!-- End Cookie Consent by TermsFeed https://www.TermsFeed.com -->
+```

code_samples/recommendations/events/basket_event.html.twig

@@ -0,0 +1,25 @@
+{# templates/cart/add_confirmation.html.twig #}
+{% extends 'base.html.twig' %}
+
+{% block content %}
+    <div class="cart-notification">
+        <p>Product "{{ product.name }}" has been added to your cart!</p>
+        <p>Quantity: {{ addedQuantity }}</p>
+    </div>
+
+    {# Build basket content string: "product-code:quantity;product-code:quantity" #}
+    {% set basketContent = [] %}
+    {% for entry in cart.entries %}
+        {% set basketContent = basketContent|merge([entry.product.code ~ ':' ~ entry.quantity]) %}
+    {% endfor %}
+    {# Track basket addition #}
+    {% set basketContext = {
+        'basketContent': basketContent|join(';'),
+        'basketId': cart.id,
+        'quantity': addedQuantity
+    } %}
+
+    {{ ibexa_tracking_track_event('basket', product, basketContext) }}
+
+    <a href="{{ path('cart_view') }}">View Cart</a>
+{% endblock %}

code_samples/recommendations/events/content_visit_event.html.twig

@@ -0,0 +1,7 @@
+{# templates/bundles/IbexaCoreBundle/default/content/full.html.twig #}
+{% extends '@!IbexaCore/default/content/full.html.twig' %}
+
+{% block content %}
+    {{ parent() }}
+    {{ ibexa_tracking_track_event('contentvisit', content) }}
+{% endblock %}

code_samples/recommendations/events/itemclicked_event.html.twig

@@ -0,0 +1,4 @@
+{{ ibexa_tracking_track_event('itemclick', product.code, {
+    'moduleName': 'homepage-recommendations',
+    'redirectUrl': path('ibexa.product.view', {'productCode': product.code})
+}) }}

code_samples/recommendations/events/product_visit_event.html.twig

@@ -0,0 +1,13 @@
+# templates/product/view.html.twig #}
+{% extends 'base.html.twig' %}
+
+{% block content %}
+    <div class="product-details">
+        <h1>{{ product.name }}</h1>
+        <p>{{ product.description }}</p>
+        <div class="price">{{ product.price }}</div>
+    </div>
+
+    {# Track product visit #}
+    {{ ibexa_tracking_track_event('visit', product) }}
+{% endblock %}

code_samples/recommendations/templates/themes/standard/ibexa/tracking/script.html.twig

@@ -0,0 +1,4 @@
+{% extends '@IbexaConnectorRaptor/themes/standard/ibexa/tracking/script.html.twig' %}
+{% block ibexa_tracking_script %}
+    console.log('My custom tracking script, but relying on loadTracking function.');
+{% endblock %}

code_samples/recommendations/templates/themes/standard/ibexa/tracking/script.js.twig

@@ -0,0 +1,5 @@
+<script type="text/javascript">
+    if (myCustomConsentIsGiven) {
+        {{ include('@ibexadesign/ibexa/tracking/script.js.twig', {'customer_id': customer_id}) }}
+    }
+</script>

code_samples/recommendations/templates/themes/standard/pagelayout.html.twig

@@ -0,0 +1,13 @@
+{# templates/pagelayout.html.twig #}
+<!DOCTYPE html>
+<html>
+<head>
+    {# ... other head content ... #}
+
+    {# Initialize Raptor tracking - must be called before any tracking events #}
+    {{ ibexa_tracking_script() }}
+</head>
+<body>
+    {# ... page content ... #}
+</body>
+</html>

code_samples/recommendations/templates/tracking/custom_visit.html.twig

@@ -0,0 +1,37 @@
+{{ ibexa_tracking_track_event(
+      'visit',
+      product,
+      {},
+      '@App/tracking/custom_visit.html.twig'
+) }}
+```
+
+{# templates/tracking/custom_visit.html.twig #}
+
+  {#
+   # Custom visit tracking template
+   #
+   # Available variables:
+   # - parameters: array of Raptor tracking parameters (p1, p2, p3, etc.)
+   # - debug: boolean flag to enable debug console messages
+   #}
+
+  <script type="text/javascript">
+      {% autoescape 'js' %}
+          (function () {
+              // Custom logic before tracking
+              console.log('Custom visit tracking template');
+              console.log('Tracking parameters:', {{ parameters|json_encode|raw }});
+
+              // Send the tracking event (REQUIRED for tracking to work)
+              const event = 'trackEvent';
+              const params = {{ parameters|json_encode|raw }};
+              window.raptor.push(event, params);
+
+              // Custom logic after tracking
+              {% if debug %}
+              console.log('Visit event tracked successfully');
+              {% endif %}
+          })();
+      {% endautoescape %}
+  </script>

composer.json

@@ -82,6 +82,7 @@
         "ibexa/phpstan": "~5.0.-dev",
         "deptrac/deptrac": "^3.0",
         "ibexa/cdp": "~5.0.x-dev",
+        "ibexa/connector-raptor": "~5.0.x-dev",
         "ibexa/image-editor": "~5.0.x-dev"
     },
     "scripts": {