Merge pull request #42 from shopware/feat/context-gateway

feat: context gateway SDK support

Author: lernhart

src/Context/ContextResolver.php

@@ -9,6 +9,7 @@
 use Shopware\App\SDK\Context\ActionButton\ActionButtonAction;
 use Shopware\App\SDK\Context\Cart\Cart;
 use Shopware\App\SDK\Context\Gateway\Checkout\CheckoutGatewayAction;
+use Shopware\App\SDK\Context\Gateway\Context\ContextGatewayAction;
 use Shopware\App\SDK\Context\Gateway\InAppFeatures\FilterAction;
 use Shopware\App\SDK\Context\InAppPurchase\InAppPurchaseProvider;
 use Shopware\App\SDK\Context\Module\ModuleAction;
@@ -288,6 +289,24 @@ public function assembleCheckoutGatewayRequest(RequestInterface $request, ShopIn
         );
     }
 
+    public function assembleContextGatewayRequest(RequestInterface $request, ShopInterface $shop): ContextGatewayAction
+    {
+        $body = \json_decode($request->getBody()->getContents(), true, flags: \JSON_THROW_ON_ERROR);
+        $request->getBody()->rewind();
+
+        if (!\is_array($body) || !isset($body['source']) || !\is_array($body['source']) || !isset($body['data']) || !\is_array($body['data'])) {
+            throw new MalformedWebhookBodyException();
+        }
+
+        return new ContextGatewayAction(
+            $shop,
+            $this->parseSource($body['source'], $shop),
+            new Cart($body['cart']),
+            new SalesChannelContext($body['salesChannelContext']),
+            $body['data'],
+        );
+    }
+
     public function assembleInAppPurchasesFilterRequest(RequestInterface $request, ShopInterface $shop): FilterAction
     {
         $body = \json_decode($request->getBody()->getContents(), true, flags: \JSON_THROW_ON_ERROR);

src/Context/Gateway/Context/ContextGatewayAction.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopware\App\SDK\Context\Gateway\Context;
+
+use Shopware\App\SDK\Context\ActionSource;
+use Shopware\App\SDK\Context\Cart\Cart;
+use Shopware\App\SDK\Context\SalesChannelContext\SalesChannelContext;
+use Shopware\App\SDK\Shop\ShopInterface;
+
+class ContextGatewayAction
+{
+    /**
+     * @param array<string, mixed> $data - Additional data to be passed to the action.
+     */
+    public function __construct(
+        public readonly ShopInterface $shop,
+        public readonly ActionSource $source,
+        public readonly Cart $cart,
+        public readonly SalesChannelContext $context,
+        public readonly array $data = [],
+    ) {
+    }
+}

src/Context/Response/Customer/AddressResponseStruct.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopware\App\SDK\Context\Response\Customer;
+
+use Shopware\App\SDK\Context\Response\ResponseStruct;
+
+class AddressResponseStruct extends ResponseStruct
+{
+    public ?string $title = null;
+    public string $firstName;
+    public string $lastName;
+    public ?string $salutationId = null;
+    public string $street;
+    public string $zipcode;
+    public string $city;
+    public ?string $company = null;
+    public ?string $department = null;
+    public ?string $countryStateId = null;
+    public string $countryId;
+    public ?string $additionalAddressLine1 = null;
+    public ?string $additionalAddressLine2 = null;
+    public ?string $phoneNumber = null;
+}

src/Context/Response/Customer/CustomerResponseStruct.php

@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopware\App\SDK\Context\Response\Customer;
+
+use Shopware\App\SDK\Context\Response\ResponseStruct;
+
+class CustomerResponseStruct extends ResponseStruct
+{
+    public ?string $title;
+
+    /**
+     * @var 'private'|'business'|null
+     */
+    public ?string $accountType = null;
+
+    public string $firstName;
+
+    public string $lastName;
+
+    public string $email;
+
+    public ?string $salutationId = null;
+
+    public bool $guest = true;
+
+    /**
+     * You find available domains in the sales channel context -> sales channel -> domains
+     */
+    public string $storefrontUrl;
+
+    public ?string $requestedGroupId = null;
+
+    public ?string $affiliateCode = null;
+
+    public ?string $campaignCode = null;
+
+    public ?int $birthdayDay = null;
+
+    public ?int $birthdayMonth = null;
+
+    public ?int $birthdayYear = null;
+
+    /**
+     * You'll need to set a password if you want to create a non-guest customer
+     * Be aware to supply a plain password, it will be hashed before it is stored by the shop instance
+     */
+    public ?string $password = null;
+
+    public AddressResponseStruct $billingAddress;
+
+    public ?AddressResponseStruct $shippingAddress = null;
+
+    /**
+     * @var string[]
+     */
+    public array $vatIds = [];
+
+    public bool $acceptedDataProtection = false;
+}

src/Context/Response/ResponseStruct.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopware\App\SDK\Context\Response;
+
+use JsonSerializable;
+
+abstract class ResponseStruct implements \JsonSerializable
+{
+    /**
+     * @return array<string, mixed>
+     */
+    public function jsonSerialize(): array
+    {
+        $data = \get_object_vars($this);
+
+        foreach ($data as $key => $value) {
+            if ($value instanceof JsonSerializable) {
+                $data[$key] = $value->jsonSerialize();
+            }
+        }
+
+        return $data;
+    }
+}

src/Gateway/Context/Command/AddCustomerMessageCommand.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopware\App\SDK\Gateway\Context\Command;
+
+use Shopware\App\SDK\Gateway\Context\ContextGatewayCommand;
+
+/**
+ * Adds an error message to be displayed to the customer in the Storefront via FlashBag messages.
+ */
+class AddCustomerMessageCommand extends ContextGatewayCommand
+{
+    final public const KEY = 'context_add-customer-message';
+
+    /**
+     * @param string $message - The message to be displayed to the customer.
+     */
+    public function __construct(
+        public string $message,
+    ) {
+        $this->keyName = self::KEY;
+        $this->setPayloadValue('message', $message);
+    }
+}

src/Gateway/Context/Command/ChangeBillingAddressCommand.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopware\App\SDK\Gateway\Context\Command;
+
+use Shopware\App\SDK\Gateway\Context\ContextGatewayCommand;
+
+/**
+ * Changes the billing address of the current customer context to the specified address ID.
+ * Be aware, that the address must be available for the current customer.
+ */
+class ChangeBillingAddressCommand extends ContextGatewayCommand
+{
+    final public const KEY = 'context_change-billing-address';
+
+    /**
+     * @param string $addressId - The address id to set as active billing address.
+     */
+    public function __construct(
+        public string $addressId,
+    ) {
+        $this->keyName = self::KEY;
+        $this->setPayloadValue('addressId', $addressId);
+    }
+}

src/Gateway/Context/Command/ChangeCurrencyCommand.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopware\App\SDK\Gateway\Context\Command;
+
+use Shopware\App\SDK\Gateway\Context\ContextGatewayCommand;
+
+/**
+ * Changes the active currency for logged in or newly registered customers
+ * Be aware that the currency must be available in the sales channel
+ */
+class ChangeCurrencyCommand extends ContextGatewayCommand
+{
+    final public const KEY = 'context_change-currency';
+
+    /**
+     * @param string $iso - The ISO 4217 currency code, e.g. EUR, USD, GBP
+     */
+    public function __construct(
+        public string $iso,
+    ) {
+        $this->keyName = self::KEY;
+        $this->setPayloadValue('iso', $iso);
+    }
+}

src/Gateway/Context/Command/ChangeLanguageCommand.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopware\App\SDK\Gateway\Context\Command;
+
+use Shopware\App\SDK\Gateway\Context\ContextGatewayCommand;
+
+/**
+ * Changes the active language for logged in customers
+ * Be aware that the language must be available in the sales channel
+ */
+class ChangeLanguageCommand extends ContextGatewayCommand
+{
+    final public const KEY = 'context_change-language';
+
+    /**
+     * @param string $iso - The BCP 47 language tag, e.g. en-US, de-DE, en-GB
+     */
+    public function __construct(
+        public string $iso,
+    ) {
+        $this->keyName = self::KEY;
+        $this->setPayloadValue('iso', $iso);
+    }
+}

src/Gateway/Context/Command/ChangePaymentMethodCommand.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopware\App\SDK\Gateway\Context\Command;
+
+use Shopware\App\SDK\Gateway\Context\ContextGatewayCommand;
+
+/**
+ * Changes the active payment method in the context.
+ * Beware that the payment method should be valid for the current context.
+ */
+class ChangePaymentMethodCommand extends ContextGatewayCommand
+{
+    final public const KEY = 'context_change-payment-method';
+
+    /**
+     * @param string $technicalName - The technical name of the payment method to be set.
+     */
+    public function __construct(
+        public string $technicalName,
+    ) {
+        $this->keyName = self::KEY;
+        $this->setPayloadValue('technicalName', $technicalName);
+    }
+}