feat: add receipt code (#314)

INT-684
myparcelnl · Nov 13, 2024 · 103b856 · 103b856
1 parent df95031
commit 103b856
Show file tree

Hide file tree

Showing 55 changed files with 608 additions and 35 deletions.
diff --git a/config/pdk-business-logic.php b/config/pdk-business-logic.php
@@ -11,6 +11,7 @@
 use MyParcelNL\Pdk\App\Options\Definition\SameDayDeliveryDefinition;
 use MyParcelNL\Pdk\App\Options\Definition\SignatureDefinition;
 use MyParcelNL\Pdk\App\Options\Definition\TrackedDefinition;
+use MyParcelNL\Pdk\App\Options\Definition\ReceiptCodeDefinition;
 use MyParcelNL\Pdk\App\Order\Calculator\General\AllowedInCarrierCalculator;
 use MyParcelNL\Pdk\App\Order\Calculator\General\CarrierSpecificCalculator;
 use MyParcelNL\Pdk\App\Order\Calculator\General\CustomerInformationCalculator;
@@ -74,6 +75,7 @@
             new SameDayDeliveryDefinition(),
             new SignatureDefinition(),
             new TrackedDefinition(),
+            new ReceiptCodeDefinition(),
         ];
     }),
 

diff --git a/config/pdk-settings.php b/config/pdk-settings.php
@@ -55,6 +55,7 @@
                         'dropOffDaysDeviations' => [],
                     ],
                     CarrierSettings::EXPORT_AGE_CHECK                        => false,
+                    CarrierSettings::EXPORT_RECEIPT_CODE                     => false,
                     CarrierSettings::EXPORT_INSURANCE                        => false,
                     CarrierSettings::EXPORT_INSURANCE_FROM_AMOUNT            => 0,
                     CarrierSettings::EXPORT_INSURANCE_PRICE_PERCENTAGE       => 100,

diff --git a/config/platform/myparcel.php b/config/platform/myparcel.php
@@ -47,6 +47,7 @@
                     'return'          => true,
                     'sameDayDelivery' => false,
                     'signature'       => true,
+                    'receiptCode'     => true,
                     'insurance'       => [
                         0,
                         10000,

diff --git a/config/schema/myparcel/order/postnl/be_package.json b/config/schema/myparcel/order/postnl/be_package.json
@@ -13,6 +13,9 @@
             },
             "tracked": {
               "enum": [0, 1]
+            },
+            "receiptCode": {
+              "enum": [-1]
             }
           }
         }

diff --git a/config/schema/myparcel/order/postnl/nl_package.json b/config/schema/myparcel/order/postnl/nl_package.json
@@ -22,6 +22,9 @@
                 500000,
                 null
               ]
+            },
+            "receiptCode": {
+              "enum": [-1, 0, 1]
             }
           }
         }

diff --git a/config/schema/order.json b/config/schema/order.json
@@ -143,6 +143,9 @@
             },
             "tracked": {
               "enum": [0, 1]
+            },
+            "receiptCode": {
+              "enum": [0, 1]
             }
           }
         }

diff --git a/src/App/Options/Definition/ReceiptCodeDefinition.php b/src/App/Options/Definition/ReceiptCodeDefinition.php
@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MyParcelNL\Pdk\App\Options\Definition;
+
+use MyParcelNL\Pdk\App\Options\Contract\OrderOptionDefinitionInterface;
+use MyParcelNL\Pdk\Settings\Model\CarrierSettings;
+use MyParcelNL\Pdk\Settings\Model\ProductSettings;
+use MyParcelNL\Pdk\Shipment\Model\ShipmentOptions;
+use MyParcelNL\Pdk\Validation\Validator\CarrierSchema;
+
+final class ReceiptCodeDefinition implements OrderOptionDefinitionInterface
+{
+    public function getCarrierSettingsKey(): ?string
+    {
+        return CarrierSettings::EXPORT_RECEIPT_CODE;
+    }
+
+    public function getProductSettingsKey(): ?string
+    {
+        return null;
+    }
+
+    public function getShipmentOptionsKey(): ?string
+    {
+        return ShipmentOptions::RECEIPT_CODE;
+    }
+
+    public function validate(CarrierSchema $carrierSchema): bool
+    {
+        return $carrierSchema->canHaveReceiptCode();
+    }
+}
diff --git a/src/App/Order/Calculator/General/PackageTypeShipmentOptionsCalculator.php b/src/App/Order/Calculator/General/PackageTypeShipmentOptionsCalculator.php
@@ -31,6 +31,7 @@ public function calculate(): void
             ShipmentOptions::ONLY_RECIPIENT    => TriStateService::DISABLED,
             ShipmentOptions::SAME_DAY_DELIVERY => TriStateService::DISABLED,
             ShipmentOptions::SIGNATURE         => TriStateService::DISABLED,
+            ShipmentOptions::RECEIPT_CODE      => TriStateService::DISABLED,
             ShipmentOptions::TRACKED           => $this->calculateTracked(),
         ]);
     }

diff --git a/src/App/Order/Calculator/PostNl/PostNLCalculator.php b/src/App/Order/Calculator/PostNl/PostNLCalculator.php
@@ -13,6 +13,7 @@ protected function getCalculators(): array
         return [
             PostNLCountryShipmentOptionsCalculator::class,
             PostNLAgeCheckCalculator::class,
+            PostNLReceiptCodeCalculator::class,
             PostNLDeliveryTypeCalculator::class,
         ];
     }

diff --git a/src/App/Order/Calculator/PostNl/PostNLReceiptCodeCalculator.php b/src/App/Order/Calculator/PostNl/PostNLReceiptCodeCalculator.php
@@ -0,0 +1,85 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MyParcelNL\Pdk\App\Order\Calculator\PostNl;
+
+use MyParcelNL\Pdk\App\Order\Calculator\AbstractPdkOrderOptionCalculator;
+use MyParcelNL\Pdk\Base\Service\CountryCodes;
+use MyParcelNL\Pdk\Types\Service\TriStateService;
+use MyParcelNL\Pdk\Validation\Validator\CarrierSchema;
+use MyParcelNL\Pdk\Facade\Pdk;
+
+/**
+ * When receipt code is enabled, insurance is required.
+ */
+final class PostNLReceiptCodeCalculator extends AbstractPdkOrderOptionCalculator
+{
+    /**
+     * Calculates the receipt code options for PostNL shipments.
+     * When receipt code is enabled:
+     * - Shipment must be to the Netherlands
+     * - Receipt code will be disabled if age check is active
+     * - Signature and only recipient will be disabled
+     * - Large format will be disabled
+     * - Return will be disabled
+     * - Insurance will be enabled (minimum €100) when no insurance is active
+     */
+    public function calculate(): void
+    {
+        $shipmentOptions = $this->order->deliveryOptions->shipmentOptions;
+
+        if (TriStateService::ENABLED !== $shipmentOptions->receiptCode) {
+            return;
+        }
+
+        if ($this->order->shippingAddress->cc !== CountryCodes::CC_NL) {
+            $shipmentOptions->receiptCode = TriStateService::DISABLED;
+            return;
+        }
+
+        if (TriStateService::ENABLED === $shipmentOptions->ageCheck) {
+            $shipmentOptions->receiptCode = TriStateService::DISABLED;
+            return;
+        }
+
+        $shipmentOptions->signature     = TriStateService::DISABLED;
+        $shipmentOptions->onlyRecipient = TriStateService::DISABLED;
+        $shipmentOptions->largeFormat   = TriStateService::DISABLED;
+        $shipmentOptions->return        = TriStateService::DISABLED;
+
+        if ($shipmentOptions->insurance === TriStateService::DISABLED) {
+            /** @var \MyParcelNL\Pdk\Validation\Validator\CarrierSchema $schema */
+            $schema                  = Pdk::get(CarrierSchema::class);
+            $allowedInsuranceAmounts = $schema
+                ->setCarrier($this->order->deliveryOptions->carrier)
+                ->getAllowedInsuranceAmounts();
+
+            $shipmentOptions->insurance = $this->getLowestInsuranceAmount($allowedInsuranceAmounts);
+        }
+    }
+
+    /**
+     * Gets the lowest allowed insurance amount that is greater than 0.
+     *
+     * @param  int[] $insuranceAmount
+     *
+     * @return int
+     */
+    private function getLowestInsuranceAmount(array $insuranceAmount): int
+    {
+        $lowestAmount = null;
+
+        foreach ($insuranceAmount as $allowedInsuranceAmount) {
+            if ($allowedInsuranceAmount <= 0) {
+                continue;
+            }
+
+            if (null === $lowestAmount || $allowedInsuranceAmount < $lowestAmount) {
+                $lowestAmount = $allowedInsuranceAmount;
+            }
+        }
+
+        return $lowestAmount ?? 0;
+    }
+}
diff --git a/src/Frontend/View/CarrierSettingsItemView.php b/src/Frontend/View/CarrierSettingsItemView.php
@@ -248,6 +248,10 @@ function (FormOperationBuilder $builder) {
                     : []
             ),
 
+            $this->carrierSchema->canHaveReceiptCode() ? [
+                new InteractiveElement(CarrierSettings::EXPORT_RECEIPT_CODE, Components::INPUT_TOGGLE),
+            ] : [],
+
             $this->carrierSchema->canHaveLargeFormat()
                 ? [new InteractiveElement(CarrierSettings::EXPORT_LARGE_FORMAT, Components::INPUT_TOGGLE)]
                 : [],

diff --git a/src/Settings/Model/CarrierSettings.php b/src/Settings/Model/CarrierSettings.php
@@ -105,6 +105,7 @@ class CarrierSettings extends AbstractSettingsModel
     public const  EXPORT_RETURN_PACKAGE_TYPE              = 'exportReturnPackageType';
     public const  EXPORT_SIGNATURE                        = 'exportSignature';
     public const  EXPORT_TRACKED                          = 'exportTracked';
+    public const  EXPORT_RECEIPT_CODE                     = 'exportReceiptCode';
     public const  PRICE_DELIVERY_TYPE_EVENING             = 'priceDeliveryTypeEvening';
     public const  PRICE_DELIVERY_TYPE_MONDAY              = 'priceDeliveryTypeMonday';
     public const  PRICE_DELIVERY_TYPE_MORNING             = 'priceDeliveryTypeMorning';
@@ -144,6 +145,7 @@ class CarrierSettings extends AbstractSettingsModel
         self::DROP_OFF_DELAY                          => 0,
         self::DROP_OFF_POSSIBILITIES                  => DropOffPossibilities::class,
         self::EXPORT_AGE_CHECK                        => false,
+        self::EXPORT_RECEIPT_CODE                     => false,
         self::EXPORT_HIDE_SENDER                      => false,
         self::EXPORT_INSURANCE                        => false,
         self::EXPORT_INSURANCE_FROM_AMOUNT            => 0,
@@ -197,6 +199,7 @@ class CarrierSettings extends AbstractSettingsModel
         self::DROP_OFF_DELAY                          => 'int',
         self::DROP_OFF_POSSIBILITIES                  => DropOffPossibilities::class,
         self::EXPORT_AGE_CHECK                        => 'bool',
+        self::EXPORT_RECEIPT_CODE                     => 'bool',
         self::EXPORT_INSURANCE                        => 'bool',
         self::EXPORT_INSURANCE_FROM_AMOUNT            => 'int',
         self::EXPORT_INSURANCE_PRICE_PERCENTAGE       => 'float',

diff --git a/src/Shipment/Model/ShipmentOptions.php b/src/Shipment/Model/ShipmentOptions.php
@@ -18,6 +18,7 @@
  * @property int<-1|0|1>         $sameDayDelivery
  * @property int<-1|0|1>         $signature
  * @property int<-1|0|1>         $tracked
+ * @property int<-1|0|1>         $receiptCode
  */
 class ShipmentOptions extends Model
 {
@@ -31,6 +32,7 @@ class ShipmentOptions extends Model
     public const SAME_DAY_DELIVERY = 'sameDayDelivery';
     public const SIGNATURE         = 'signature';
     public const TRACKED           = 'tracked';
+    public const RECEIPT_CODE      = 'receiptCode';
 
     protected $attributes = [
         self::LABEL_DESCRIPTION => null,
@@ -43,6 +45,7 @@ class ShipmentOptions extends Model
         self::SAME_DAY_DELIVERY => TriStateService::INHERIT,
         self::SIGNATURE         => TriStateService::INHERIT,
         self::TRACKED           => TriStateService::INHERIT,
+        self::RECEIPT_CODE      => TriStateService::INHERIT,
     ];
 
     protected $casts      = [
@@ -56,5 +59,6 @@ class ShipmentOptions extends Model
         self::SAME_DAY_DELIVERY => TriStateService::TYPE_STRICT,
         self::SIGNATURE         => TriStateService::TYPE_STRICT,
         self::TRACKED           => TriStateService::TYPE_STRICT,
+        self::RECEIPT_CODE      => TriStateService::TYPE_STRICT,
     ];
 }
diff --git a/src/Validation/Validator/CarrierSchema.php b/src/Validation/Validator/CarrierSchema.php
@@ -12,6 +12,7 @@
 use MyParcelNL\Pdk\App\Options\Definition\InsuranceDefinition;
 use MyParcelNL\Pdk\App\Options\Definition\LargeFormatDefinition;
 use MyParcelNL\Pdk\App\Options\Definition\OnlyRecipientDefinition;
+use MyParcelNL\Pdk\App\Options\Definition\ReceiptCodeDefinition;
 use MyParcelNL\Pdk\App\Options\Definition\SameDayDeliveryDefinition;
 use MyParcelNL\Pdk\App\Options\Definition\SignatureDefinition;
 use MyParcelNL\Pdk\App\Options\Definition\TrackedDefinition;
@@ -127,6 +128,11 @@ public function canHavePickup(): bool
         return $this->hasDeliveryType(DeliveryOptions::DELIVERY_TYPE_PICKUP_NAME);
     }
 
+    public function canHaveReceiptCode(): bool
+    {
+        return $this->canHave(ReceiptCodeDefinition::class);
+    }
+
     public function canHaveSameDayDelivery(): bool
     {
         return $this->canHave(SameDayDeliveryDefinition::class);
-Original file line number
+Diff line change
@@ Expand Up / @@ -22,6 +22,9 @@ @@
 ,
                     null
                   ]
+                },
+                "receiptCode": {
+                  "enum": [-1, 0, 1]
                 }
               }
             }
@@ Expand Down @@