[5.1] Custom line items (non-purchasable dependent)

CHANGELOG-WIP.md

@@ -1,12 +1,40 @@
 # Release Notes for Craft Commerce 5.1 (WIP)
 
-## Unreleased 5.1
+## 5.1.0
+
+### Store Management
+- It’s now possible to create custom line items.
+- Added the `commerceCustomLineItem()` Twig function.
 
 ### Administration
 - Added a new “Manage subscription plans” permission.
 - Added a new “Manage donation settings” permission.
 - Added a new “Manage store general setting” permission.
 - Added a new “Manage payment currencies” permission.
 
+### Development
+
+### Extensibility
+- Added `craft\commerce\enums\LineItemType`.
+- Added `craft\commerce\helpers\LineItem::generateCustomLineItemHash()`.
+- Added `craft\commerce\models\LineItem::$type`.
+- Added `craft\commerce\models\LineItem::populate()`.
+- Added `craft\commerce\models\LineItem::refresh()`.
+- Added `craft\commerce\models\LineItem::getHasFreeShipping()`.
+- Added `craft\commerce\models\LineItem::setHasFreeShipping()`.
+- Added `craft\commerce\models\LineItem::getIsPromotable()`.
+- Added `craft\commerce\models\LineItem::setIsPromotable()`.
+- Added `craft\commerce\models\LineItem::getIsShippable()`.
+- Added `craft\commerce\models\LineItem::setIsShippable()`.
+- Added `craft\commerce\models\LineItem::getIsTaxable()`.
+- Added `craft\commerce\models\LineItem::setIsTaxable()`.
+- Added `craft\commerce\models\Order::EVENT_AFTER_LINE_ITEMS_REFRESHED`.
+- Added `craft\commerce\models\Order::EVENT_BEFORE_LINE_ITEMS_REFRESHED`.
+- Added `craft\commerce\services\LineItems::create()`.
+- Added `craft\commerce\services\LineItems::resolveCustomLineItem()`.
+- Deprecated `craft\commerce\models\LineItem::populateFromPurchasable()`. Use `populate()` instead.
+- Deprecated `craft\commerce\models\LineItem::refreshFromPurchasable()`. Use `refresh()` instead.
+- Deprecated `craft\commerce\services\LineItems::createLineItem()`. Use `create()` instead.
+
 ### System
-- Craft Commerce now requires Craft CMS 5.2 or later.
+- Craft Commerce now requires Craft CMS 5.2 or later.

src/Plugin.php

@@ -250,7 +250,7 @@ public static function editions(): array
     /**
      * @inheritDoc
      */
-    public string $schemaVersion = '5.0.76';
+    public string $schemaVersion = '5.0.77';
 
     /**
      * @inheritdoc

src/adjusters/Discount.php

@@ -164,8 +164,7 @@ public function adjust(Order $order): array
 
             // Remove non-promotable line items
             $lineItemsByPrice = ArrayHelper::where($lineItemsByPrice, function(LineItem $lineItem) {
-                $purchasable = $lineItem->getPurchasable();
-                return $purchasable && $purchasable->getIsPromotable();
+                return $lineItem->getIsPromotable();
             }, true, true);
 
             // Loop over each order level adjustment and add an adjustment to each line item until it runs out.

src/adjusters/Shipping.php

@@ -67,8 +67,7 @@ public function adjust(Order $order): array
         $nonShippableItems = [];
 
         foreach ($lineItems as $item) {
-            $purchasable = $item->getPurchasable();
-            if ($purchasable && !Plugin::getInstance()->getPurchasables()->isPurchasableShippable($purchasable, $order)) {
+            if (!$item->getIsShippable()) {
                 $nonShippableItems[$item->id] = $item->id;
             }
         }
@@ -128,9 +127,10 @@ public function adjust(Order $order): array
                         }
                     }
 
-                    $freeShippingFlagOnProduct = $item->purchasable->hasFreeShipping();
-                    $shippable = Plugin::getInstance()->getPurchasables()->isPurchasableShippable($item->getPurchasable(), $order);
-                    if (!$freeShippingFlagOnProduct && !$hasFreeShippingFromDiscount && $shippable) {
+                    $lineItemHasFreeShipping = $item->getHasFreeShipping();
+                    $shippable = $item->getIsShippable();
+
+                    if (!$lineItemHasFreeShipping && !$hasFreeShippingFromDiscount && $shippable) {
                         $adjustment = $this->_createAdjustment($shippingMethod, $rule);
 
                         $percentageRate = $rule->getPercentageRate($item->shippingCategoryId);

src/base/ShippingMethod.php

@@ -12,7 +12,6 @@
 use craft\commerce\elements\conditions\orders\ShippingMethodOrderCondition;
 use craft\commerce\elements\Order;
 use craft\commerce\errors\NotImplementedException;
-use craft\commerce\Plugin;
 use craft\helpers\Json;
 use DateTime;
 use Illuminate\Support\Collection;
@@ -230,10 +229,11 @@ public function getPriceForOrder(Order $order): float
         $nonShippableItems = [];
 
         foreach ($lineItems as $item) {
-            $purchasable = $item->getPurchasable();
-            if ($purchasable && !Plugin::getInstance()->getPurchasables()->isPurchasableShippable($purchasable, $order)) {
-                $nonShippableItems[$item->id] = $item->id;
+            if ($item->getIsShippable()) {
+                continue;
             }
+
+            $nonShippableItems[$item->id] = $item->id;
         }
 
         // Are all line items non shippable items? No shipping cost.
@@ -244,17 +244,23 @@ public function getPriceForOrder(Order $order): float
         $amount = $shippingRule->getBaseRate();
 
         foreach ($order->getLineItems() as $item) {
-            if ($item->getPurchasable() && !$item->purchasable->hasFreeShipping() && Plugin::getInstance()->getPurchasables()->isPurchasableShippable($item->getPurchasable(), $order)) {
-                $percentageRate = $shippingRule->getPercentageRate($item->shippingCategoryId);
-                $perItemRate = $shippingRule->getPerItemRate($item->shippingCategoryId);
-                $weightRate = $shippingRule->getWeightRate($item->shippingCategoryId);
-
-                $percentageAmount = $item->getSubtotal() * $percentageRate;
-                $perItemAmount = $item->qty * $perItemRate;
-                $weightAmount = ($item->weight * $item->qty) * $weightRate;
+            if ($item->getHasFreeShipping()) {
+                continue;
+            }
 
-                $amount += ($percentageAmount + $perItemAmount + $weightAmount);
+            if (!$item->getIsShippable()) {
+                continue;
             }
+
+            $percentageRate = $shippingRule->getPercentageRate($item->shippingCategoryId);
+            $perItemRate = $shippingRule->getPerItemRate($item->shippingCategoryId);
+            $weightRate = $shippingRule->getWeightRate($item->shippingCategoryId);
+
+            $percentageAmount = $item->getSubtotal() * $percentageRate;
+            $perItemAmount = $item->qty * $perItemRate;
+            $weightAmount = ($item->weight * $item->qty) * $weightRate;
+
+            $amount += ($percentageAmount + $perItemAmount + $weightAmount);
         }
 
         $amount = max($amount, $shippingRule->getMinRate());

src/controllers/CartController.php

@@ -19,6 +19,7 @@
 use craft\elements\User;
 use craft\errors\ElementNotFoundException;
 use craft\errors\MissingComponentException;
+use craft\helpers\Json;
 use craft\helpers\UrlHelper;
 use Illuminate\Support\Collection;
 use Throwable;
@@ -160,7 +161,7 @@ public function actionUpdateCart(): ?Response
             if ($qty > 0) {
                 // We only want a new line item if they cleared the cart
                 if ($clearLineItems) {
-                    $lineItem = Plugin::getInstance()->getLineItems()->createLineItem($this->_cart, $purchasableId, $options);
+                    $lineItem = Plugin::getInstance()->getLineItems()->create($this->_cart, compact('purchasableId', 'options'));
                 } else {
                     $lineItem = Plugin::getInstance()->getLineItems()->resolveLineItem($this->_cart, $purchasableId, $options);
                 }
@@ -212,7 +213,10 @@ public function actionUpdateCart(): ?Response
 
                     // We only want a new line item if they cleared the cart
                     if ($clearLineItems) {
-                        $lineItem = Plugin::getInstance()->getLineItems()->createLineItem($this->_cart, $purchasable['id'], $purchasable['options']);
+                        $lineItem = Plugin::getInstance()->getLineItems()->create($this->_cart, [
+                            'purchasableId' => $purchasable['id'],
+                            'options' => $purchasable['options'],
+                        ]);
                     } else {
                         $lineItem = Plugin::getInstance()->getLineItems()->resolveLineItem($this->_cart, $purchasable['id'], $purchasable['options']);
                     }
@@ -230,6 +234,46 @@ public function actionUpdateCart(): ?Response
             }
         }
 
+        if ($customLineItems = $this->request->getParam('customLineItems')) {
+            foreach ($customLineItems as $key => $customLineItem) {
+                $customLineItemData = $this->request->getValidatedBodyParam("customLineItems.$key.lineItem");
+                if (!$customLineItemData) {
+                    continue;
+                }
+
+                $customLineItemData = Json::decodeIfJson($customLineItemData);
+                if (!is_array($customLineItemData) || !isset($customLineItemData['description'], $customLineItemData['price'], $customLineItemData['sku'])) {
+                    continue;
+                }
+
+                $qty = (int)$this->request->getParam("customLineItems.$key.qty", 1);
+                if ($qty === 0) {
+                    continue;
+                }
+
+                $note = $this->request->getParam("customLineItems.$key.note", '');
+                $options = $this->request->getParam("customLineItems.$key.options", []);
+
+                // Resolve custom line item
+                $customLineItem = Plugin::getInstance()->getLineItems()->resolveCustomLineItem($this->_cart, $customLineItemData['sku'], $options);
+
+                $customLineItem->description = $customLineItemData['description'];
+                $customLineItem->price = $customLineItemData['price'];
+                $customLineItem->sku = $customLineItemData['sku'];
+                $customLineItem->taxCategoryId = $customLineItemData['taxCategoryId'];
+                $customLineItem->shippingCategoryId = $customLineItemData['shippingCategoryId'];
+                $customLineItem->setHasFreeShipping($customLineItemData['hasFreeShipping']);
+                $customLineItem->setIsPromotable($customLineItemData['isPromotable']);
+                $customLineItem->setIsShippable($customLineItemData['isShippable']);
+                $customLineItem->setIsTaxable($customLineItemData['isTaxable']);
+                $customLineItem->qty = $qty;
+                $customLineItem->note = $note;
+                $customLineItem->setOptions($options);
+
+                $this->_cart->addLineItem($customLineItem);
+            }
+        }
+
         // Update multiple line items in the cart
         if ($lineItems = $this->request->getParam('lineItems')) {
             foreach ($lineItems as $key => $lineItem) {

src/controllers/OrdersController.php

@@ -18,6 +18,7 @@
 use craft\commerce\db\Table;
 use craft\commerce\elements\Order;
 use craft\commerce\enums\InventoryTransactionType;
+use craft\commerce\enums\LineItemType;
 use craft\commerce\errors\CurrencyException;
 use craft\commerce\errors\OrderStatusException;
 use craft\commerce\errors\RefundException;
@@ -59,6 +60,7 @@
 use craft\helpers\StringHelper;
 use craft\helpers\UrlHelper;
 use craft\models\Site;
+use craft\web\assets\money\MoneyAsset;
 use craft\web\Controller;
 use craft\web\View;
 use DateTime;
@@ -598,6 +600,10 @@ private function _orderToArray(Order $order): array
         $lineItems = $order->getLineItems();
         $purchasableCpEditUrlByPurchasableId = [];
         foreach ($lineItems as $lineItem) {
+            if ($lineItem->type === LineItemType::Custom) {
+                continue;
+            }
+
             /** @var Purchasable|PurchasableElement|null $purchasable */
             $purchasable = $lineItem->getPurchasable();
             if (!$purchasable || isset($purchasableCpEditUrlByPurchasableId[$purchasable->id])) {
@@ -1336,6 +1342,8 @@ private function _registerJavascript(array $variables): void
         /** @var Order $order */
         $order = $variables['order'];
         Craft::$app->getView()->registerAssetBundle(CommerceOrderAsset::class);
+        // Include the input mask asset for use in pricing fields
+        Craft::$app->getView()->registerAssetBundle(MoneyAsset::class);
 
         Craft::$app->getView()->registerJs('window.orderEdit = {};', View::POS_BEGIN);
 
@@ -1352,12 +1360,22 @@ private function _registerJavascript(array $variables): void
         $lineItemStatuses = Plugin::getInstance()->getLineItemStatuses()->getAllLineItemStatuses($order->storeId)->all();
         Craft::$app->getView()->registerJs('window.orderEdit.lineItemStatuses = ' . Json::encode($lineItemStatuses) . ';', View::POS_BEGIN);
 
+        $lineItemTypes = LineItemType::types();
+
+        Craft::$app->getView()->registerJs('window.orderEdit.lineItemTypes = ' . Json::encode($lineItemTypes) . ';', View::POS_BEGIN);
+
         $taxCategories = Plugin::getInstance()->getTaxCategories()->getAllTaxCategoriesAsList();
         Craft::$app->getView()->registerJs('window.orderEdit.taxCategories = ' . Json::encode(ArrayHelper::toArray($taxCategories)) . ';', View::POS_BEGIN);
 
+        $defaultTaxCategoryId = Plugin::getInstance()->getTaxCategories()->getDefaultTaxCategory()->id;
+        Craft::$app->getView()->registerJs('window.orderEdit.defaultTaxCategoryId = ' . Json::encode($defaultTaxCategoryId) . ';', View::POS_BEGIN);
+
         $shippingCategories = Plugin::getInstance()->getShippingCategories()->getAllShippingCategoriesAsList($order->storeId);
         Craft::$app->getView()->registerJs('window.orderEdit.shippingCategories = ' . Json::encode(ArrayHelper::toArray($shippingCategories)) . ';', View::POS_BEGIN);
 
+        $defaultShippingCategoryId = Plugin::getInstance()->getShippingCategories()->getDefaultShippingCategory($order->storeId)->id;
+        Craft::$app->getView()->registerJs('window.orderEdit.defaultShippingCategoryId = ' . Json::encode($defaultShippingCategoryId) . ';', View::POS_BEGIN);
+
         $currentUser = Craft::$app->getUser()->getIdentity();
         $permissions = [
             'commerce-manageOrders' => $currentUser->can('commerce-manageOrders'),
@@ -1541,26 +1559,48 @@ private function _updateOrder(Order $order, $orderRequestData, bool $tryAutoSet
 
         foreach ($orderRequestData['order']['lineItems'] as $lineItemData) {
             // Normalize data
+            $type = $lineItemData['type'] ?? LineItemType::Purchasable;
+            if (is_string($type)) {
+                $type = LineItemType::from($type);
+            } elseif (is_array($type) && isset($type['value'])) {
+                $type = LineItemType::from($type['value']);
+            }
+
+            $description = $lineItemData['description'] ?? null;
+            $sku = $lineItemData['sku'] ?? null;
             $lineItemId = $lineItemData['id'] ?? null;
             $note = $lineItemData['note'] ?? '';
             $privateNote = $lineItemData['privateNote'] ?? '';
             $purchasableId = $lineItemData['purchasableId'];
             $lineItemStatusId = $lineItemData['lineItemStatusId'];
             $options = $lineItemData['options'] ?? [];
             $qty = $lineItemData['qty'] ?? 1;
+            $shippingCategoryId = $lineItemData['shippingCategoryId'] ?? null;
+            $taxCategoryId = $lineItemData['taxCategoryId'] ?? null;
+            $hasFreeShipping = $lineItemData['hasFreeShipping'] ?? null;
+            $isPromotable = $lineItemData['isPromotable'] ?? null;
+            $isShippable = $lineItemData['isShippable'] ?? null;
+            $isTaxable = $lineItemData['isTaxable'] ?? null;
             $uid = $lineItemData['uid'] ?? StringHelper::UUID();
 
             if ($lineItemId) {
                 $lineItem = Plugin::getInstance()->getLineItems()->getLineItemById($lineItemId);
             } else {
                 try {
-                    $lineItem = Plugin::getInstance()->getLineItems()->createLineItem($order, $purchasableId, $options, $qty, $note, $uid);
+                    $params = compact('options', 'qty', 'note', 'uid');
+                    if ($type === LineItemType::Purchasable) {
+                        $params['purchasableId'] = $purchasableId;
+                    }
+
+                    $lineItem = Plugin::getInstance()->getLineItems()->create($order, $params, $type);
                 } catch (\Exception $exception) {
                     $order->addError('lineItems', $exception->getMessage());
                     continue;
                 }
             }
 
+            $lineItem->type = $type;
+
             $lineItem->purchasableId = $purchasableId;
             $lineItem->qty = $qty;
             $lineItem->note = $note;
@@ -1571,14 +1611,48 @@ private function _updateOrder(Order $order, $orderRequestData, bool $tryAutoSet
 
             $lineItem->setOrder($order);
 
+            if ($lineItem->type === LineItemType::Custom) {
+                if ($description) {
+                    $lineItem->setDescription($description);
+                }
+
+                if ($sku) {
+                    $lineItem->setSku($sku);
+                }
+
+                if ($shippingCategoryId) {
+                    $lineItem->shippingCategoryId = $shippingCategoryId;
+                }
+
+                if ($taxCategoryId) {
+                    $lineItem->taxCategoryId = $taxCategoryId;
+                }
+
+                if ($hasFreeShipping !== null) {
+                    $lineItem->setHasFreeShipping($hasFreeShipping);
+                }
+
+                if ($isPromotable !== null) {
+                    $lineItem->setIsPromotable($isPromotable);
+                }
+
+                if ($isShippable !== null) {
+                    $lineItem->setIsShippable($isShippable);
+                }
+
+                if ($isTaxable !== null) {
+                    $lineItem->setIsTaxable($isTaxable);
+                }
+            }
+
             // Deleted a purchasable while we had a purchasable ID in memory on the order edit page, unset it.
-            if ($purchasableId && !Plugin::getInstance()->getPurchasables()->getPurchasableById($purchasableId, $orderRequestData['order']['orderSiteId'], $orderRequestData['order']['customerId'] ?? false)) {
+            if ($lineItem->type === LineItemType::Purchasable && $purchasableId && !Plugin::getInstance()->getPurchasables()->getPurchasableById($purchasableId, $orderRequestData['order']['orderSiteId'], $orderRequestData['order']['customerId'] ?? false)) {
                 $lineItem->purchasableId = null;
             }
 
-            if ($order->getRecalculationMode() == Order::RECALCULATION_MODE_NONE) {
+            if ($order->getRecalculationMode() == Order::RECALCULATION_MODE_NONE || $lineItem->type === LineItemType::Custom) {
                 $promotionalPrice = $lineItemData['promotionalPrice'] ? Localization::normalizeNumber($lineItemData['promotionalPrice']) : null;
-                $price = $lineItemData['price'] ? Localization::normalizeNumber($lineItemData['price']) : null;
+                $price = $lineItemData['price'] ? Localization::normalizeNumber($lineItemData['price']) : 0;
 
                 $lineItem->setPromotionalPrice($promotionalPrice);
                 $lineItem->setPrice($price);