@frontastic/common 2.30.1 → 2.31.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # common Changelog
 
+## `2.31.0` (2022-04-07)
+
+* feat(FP-1794): extracted logic to validate cart status before checkout
+
 ## `2.30.1` (2022-04-07)
 
 * fix(FP-1794): consider only single successful payment as payment completed

package/composer.json

@@ -1,7 +1,7 @@
 {
     "name": "frontastic/common",
     "license": "None",
-    "version": "2.30.1",
+    "version": "2.31.0",
     "repositories": [
         {
             "type": "path",

package/docs/README.md

@@ -67,7 +67,9 @@ Here you find the API documentation for the relevant classes:
       * [LifecycleEventDecorator](php/CartApiBundle/Domain/CartApi/LifecycleEventDecorator.md)
     * [CartApiBase](php/CartApiBundle/Domain/CartApiBase.md)
     * [CartApiFactory](php/CartApiBundle/Domain/CartApiFactory.md)
+    * [CartCheckoutService](php/CartApiBundle/Domain/CartCheckoutService.md)
     * [DefaultCartApiFactory](php/CartApiBundle/Domain/DefaultCartApiFactory.md)
+    * [DefaultCartCheckoutService](php/CartApiBundle/Domain/DefaultCartCheckoutService.md)
     * [Discount](php/CartApiBundle/Domain/Discount.md)
     * [DummyCartApiFactory](php/CartApiBundle/Domain/DummyCartApiFactory.md)
     * [LineItem](php/CartApiBundle/Domain/LineItem.md)

package/docs/php/CartApiBundle/Domain/Cart.md

@@ -88,11 +88,6 @@ Return Value: `bool`
 public function isReadyForCheckout(): bool
 ```
 
-*Some commerce backends might consider a cart ready without payment(s).*
-
-This method will return true if there are no payments or if all payments
-had paid status and the total amounts are equal to cart total amount.
-
 Return Value: `bool`
 
 ### isComplete()

package/docs/php/CartApiBundle/Domain/CartApi/Commercetools.md

@@ -25,6 +25,7 @@ public function __construct(
     Commercetools\Mapper $cartMapper,
     Commercetools\Locale\CommercetoolsLocaleCreator $localeCreator,
     OrderIdGeneratorV2 $orderIdGenerator,
+    CartCheckoutService $cartCheckoutService,
     \Psr\Log\LoggerInterface $logger,
     ?Commercetools\Options $options = null
 ): mixed
@@ -36,6 +37,7 @@ Argument|Type|Default|Description
 `$cartMapper`|[`Commercetools`](Commercetools.md)\Mapper||
 `$localeCreator`|[`Commercetools`](../../../ProductApiBundle/Domain/ProductApi/Commercetools.md)\Locale\CommercetoolsLocaleCreator||
 `$orderIdGenerator`|[`OrderIdGeneratorV2`](../OrderIdGeneratorV2.md)||
+`$cartCheckoutService`|[`CartCheckoutService`](../CartCheckoutService.md)||
 `$logger`|`\Psr\Log\LoggerInterface`||
 `$options`|?[`Commercetools`](Commercetools.md)\Options|`null`|
 

package/docs/php/CartApiBundle/Domain/CartCheckoutService.md

@@ -0,0 +1,68 @@
+# `interface`  CartCheckoutService
+
+**Fully Qualified**: [`\Frontastic\Common\CartApiBundle\Domain\CartCheckoutService`](../../../../src/php/CartApiBundle/Domain/CartCheckoutService.php)
+
+## Methods
+
+* [getPayedAmount()](#getpayedamount)
+* [hasCompletePayments()](#hascompletepayments)
+* [isPaymentCompleted()](#ispaymentcompleted)
+* [isReadyForCheckout()](#isreadyforcheckout)
+
+### getPayedAmount()
+
+```php
+public function getPayedAmount(
+    Cart $cart
+): int
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$cart`|[`Cart`](Cart.md)||
+
+Return Value: `int`
+
+### hasCompletePayments()
+
+```php
+public function hasCompletePayments(
+    Cart $cart
+): bool
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$cart`|[`Cart`](Cart.md)||
+
+Return Value: `bool`
+
+### isPaymentCompleted()
+
+```php
+public function isPaymentCompleted(
+    Payment $payment
+): bool
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$payment`|[`Payment`](Payment.md)||
+
+Return Value: `bool`
+
+### isReadyForCheckout()
+
+```php
+public function isReadyForCheckout(
+    Cart $cart
+): bool
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$cart`|[`Cart`](Cart.md)||
+
+Return Value: `bool`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/docs/php/CartApiBundle/Domain/DefaultCartApiFactory.md

@@ -17,6 +17,7 @@ public function __construct(
     AccountApiFactory $accountApiFactory,
     object $orderIdGenerator,
     iterable $decorators,
+    CartCheckoutService $cartCheckoutService,
     \Psr\Log\LoggerInterface $logger
 ): mixed
 ```
@@ -27,6 +28,7 @@ Argument|Type|Default|Description
 `$accountApiFactory`|[`AccountApiFactory`](../../AccountApiBundle/Domain/AccountApiFactory.md)||
 `$orderIdGenerator`|`object`||
 `$decorators`|`iterable`||
+`$cartCheckoutService`|[`CartCheckoutService`](CartCheckoutService.md)||
 `$logger`|`\Psr\Log\LoggerInterface`||
 
 Return Value: `mixed`

package/docs/php/CartApiBundle/Domain/DefaultCartCheckoutService.md

@@ -0,0 +1,77 @@
+#  DefaultCartCheckoutService
+
+**Fully Qualified**: [`\Frontastic\Common\CartApiBundle\Domain\DefaultCartCheckoutService`](../../../../src/php/CartApiBundle/Domain/DefaultCartCheckoutService.php)
+
+**Implements**: [`CartCheckoutService`](CartCheckoutService.md)
+
+## Methods
+
+* [getPayedAmount()](#getpayedamount)
+* [hasCompletePayments()](#hascompletepayments)
+* [isPaymentCompleted()](#ispaymentcompleted)
+* [isReadyForCheckout()](#isreadyforcheckout)
+
+### getPayedAmount()
+
+```php
+public function getPayedAmount(
+    Cart $cart
+): int
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$cart`|[`Cart`](Cart.md)||
+
+Return Value: `int`
+
+### hasCompletePayments()
+
+```php
+public function hasCompletePayments(
+    Cart $cart
+): bool
+```
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$cart`|[`Cart`](Cart.md)||
+
+Return Value: `bool`
+
+### isPaymentCompleted()
+
+```php
+public function isPaymentCompleted(
+    Payment $payment
+): bool
+```
+
+*We only consider payments with status "paid" as completed*
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$payment`|[`Payment`](Payment.md)||
+
+Return Value: `bool`
+
+### isReadyForCheckout()
+
+```php
+public function isReadyForCheckout(
+    Cart $cart
+): bool
+```
+
+*Some commerce backends might consider a cart ready without payment(s).*
+
+This method will return true if there are no payments or if all payments
+had paid status and the total amounts are equal to cart total amount.
+
+Argument|Type|Default|Description
+--------|----|-------|-----------
+`$cart`|[`Cart`](Cart.md)||
+
+Return Value: `bool`
+
+Generated with [Frontastic API Docs](https://github.com/FrontasticGmbH/apidocs).

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@frontastic/common",
-    "version": "2.30.1",
+    "version": "2.31.0",
     "devDependencies": {
         "@babel/core": "7.5.4",
         "@babel/plugin-proposal-class-properties": "^7.5.0",