[5.x] Inventory Import/Export

.github/workflows/ci.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - '5.x'
+      - '5.4'
   pull_request:
 permissions:
   contents: read

CHANGELOG-WIP.md

@@ -0,0 +1 @@
+# Release Notes for Craft Commerce 5.4 (WIP)

composer.json

@@ -26,6 +26,7 @@
     "dompdf/dompdf": "^2.0.2",
     "ibericode/vat": "^1.2.2",
     "iio/libmergepdf": "^4.0",
+    "league/csv": "^9.22",
     "moneyphp/money": "^4.2.0"
   },
   "require-dev": {

src/controllers/InventoryController.php

@@ -27,6 +27,7 @@
 use craft\helpers\ArrayHelper;
 use craft\helpers\Cp;
 use craft\helpers\Html;
+use craft\helpers\UrlHelper;
 use craft\web\assets\htmx\HtmxAsset;
 use craft\web\Controller;
 use craft\web\CpScreenResponseBehavior;
@@ -197,12 +198,41 @@ public function actionEditLocationLevels(?string $inventoryLocationHandle = null
             ];
         }
 
+        $importBtnId = sprintf("import-%s", mt_rand());
+        $items['import'] = [
+            'type' => MenuItemType::Button,
+            'id' => $importBtnId,
+            'icon' => 'arrow-down',
+            'label' => Craft::t('commerce', 'Import Inventory'),
+        ];
+
+        // make import button open a slideout
+        $view->registerJsWithVars(fn($id, $settings) => <<<JS
+$('#' + $id).on('click', (e) => {
+  e.preventDefault(); 
+  const slideout = new Craft.CpScreenSlideout('commerce/inventory-importexport', $settings);
+});
+JS, [
+            $view->namespaceInputId($importBtnId),
+            [],
+        ]);
+
+        $exportBtnId = sprintf("export-%s", mt_rand());
+        $items['export'] = [
+            'type' => MenuItemType::Link,
+            'id' => $exportBtnId,
+            'url' => UrlHelper::actionUrl('commerce/inventory-importexport/export', ['inventoryLocationId' => $currentLocation->id]),
+            'icon' => 'arrow-up',
+            'label' => Craft::t('commerce', 'Export Inventory'),
+        ];
+
         return $this->asCpScreen()
             ->title($title)
             ->site(Cp::requestedSite())
             ->selectableSites(Craft::$app->getSites()->getEditableSites())
             ->action(null)
             ->crumbs($crumbs)
+            ->actionMenuItems(fn() => $items)
             ->contentTemplate('commerce/inventory/levels/_index', compact(
                 'inventoryLocations',
                 'currentLocation',
@@ -532,7 +562,7 @@ public function actionUpdateLevels(): Response
         }
 
         if (count($errors) > 0) {
-            return $this->asFailure(Craft::t('commerce', 'Inventory was not updated.',),
+            return $this->asFailure(Craft::t('commerce', 'Inventory was not updated.'),
                 ['errors' => $errors]
             );
         }

src/controllers/InventoryImportexportController.php

@@ -0,0 +1,203 @@
+<?php
+
+namespace craft\commerce\controllers;
+
+use Craft;
+use craft\commerce\db\Table;
+use craft\commerce\Plugin;
+use craft\commerce\queue\jobs\ImportInventory;
+use craft\commerce\web\assets\commercecp\CommerceCpAsset;
+use craft\web\Controller;
+use craft\web\CpScreenResponseBehavior;
+use craft\web\UploadedFile;
+use League\Csv\Writer;
+use yii\base\InvalidConfigException;
+use yii\web\Response;
+
+/**
+ * Inventory Importexport controller
+ */
+class InventoryImportexportController extends Controller
+{
+    public $defaultAction = 'index';
+    protected array|int|bool $allowAnonymous = self::ALLOW_ANONYMOUS_NEVER;
+
+    /**
+     * commerce/inventory-importexport action
+     */
+    public function actionIndex(): Response
+    {
+        $params = [];
+
+        return $this->_importScreen()
+            ->prepareScreen(function(Response $response, string $containerId) {
+                /** @var CpScreenResponseBehavior $response */
+                $view = Craft::$app->getView();
+                $view->registerJsWithVars(
+                    fn($containerId) => <<<JS
+                        $(function() {
+                            var \$container = $('#' + $containerId);
+                            if (\$container.length) {
+                                new Craft.Commerce.InventoryImportFileUploader('#' + $containerId);
+                            }
+                        });
+                    JS,
+                    [$containerId]
+                );
+            })
+            ->contentTemplate('commerce/inventory/importexport/_importScreen', $params);
+    }
+
+    public function actionImportInventory()
+    {
+        $this->requirePostRequest();
+        $this->requirePermission('commerce-manageInventoryStockLevels');
+
+        $tempFilename = Craft::$app->getRequest()->getBodyParam('importFilename');
+        if (!$tempFilename) {
+            return $this->asFailure(Craft::t('commerce', 'No file specified.'));
+        }
+
+        $tempDirectory = Craft::$app->getPath()->getTempPath() . '/commerce-inventory-import';
+        $tempFilePath = $tempDirectory . '/' . $tempFilename;
+
+        if (!file_exists($tempFilePath)) {
+            return $this->asFailure(Craft::t('commerce', 'File not found.'));
+        }
+
+        // Create and queue the import job
+        $jobId = Craft::$app->getQueue()->push(new ImportInventory([
+            'description' => Craft::t('commerce', 'Import inventory from CSV'),
+            'filePath' => $tempFilePath,
+        ]));
+
+        $message = Craft::t('commerce', 'Inventory import has been queued.');
+        return $this->asSuccess($message);
+    }
+
+    private function _importScreen()
+    {
+        // Register Commerce CP Assets
+        $this->view->registerAssetBundle(CommerceCpAsset::class);
+
+        return $this->asCpScreen()
+            ->action('commerce/inventory-importexport/import-inventory')
+            ->addCrumb(Craft::t('commerce', 'Inventory'), 'commerce/inventory')
+            ->selectedSubnavItem('inventory')
+            ->redirectUrl('commerce/inventory')
+            ->title(Craft::t('commerce', 'Import Inventory'))
+            ->formAttributes(['enctype' => 'multipart/form-data', 'accept-charset' => 'UTF-8'])
+            ->metaSidebarTemplate('commerce/inventory/importexport/_importMeta')
+            ->submitButtonLabel(Craft::t('commerce', 'Import'));
+    }
+
+    /**
+     * @return Response
+     * @throws InvalidConfigException
+     * @throws \yii\web\ForbiddenHttpException
+     * @throws \yii\web\HttpException
+     * @throws \yii\web\RangeNotSatisfiableHttpException
+     */
+    public function actionExport(): Response
+    {
+        $this->requirePermission('commerce-manageInventoryStockLevels');
+
+        $inventoryLocationId = (int)Craft::$app->getRequest()->getParam('inventoryLocationId');
+        $inventoryLocation = Plugin::getInstance()->getInventoryLocations()->getInventoryLocationById($inventoryLocationId);
+
+        $inventoryQuery = Plugin::getInstance()->getInventory()->getInventoryLevelQuery()
+            ->andWhere(['inventoryLocationId' => $inventoryLocation->id]);
+
+        $inventoryQuery->leftJoin(['purchasables' => Table::PURCHASABLES], '[[purchasables.id]] = [[ii.purchasableId]]');
+        $inventoryQuery->addSelect(['sku' => 'purchasables.sku']);
+        $inventoryQuery->addSelect(['description' => 'purchasables.description']);
+
+        $response = Craft::$app->getResponse();
+        $response->headers->set('Content-Type', 'text/csv');
+        $response->headers->set('Content-Disposition', 'attachment; filename="inventory.csv"');
+        $response->format = \yii\web\Response::FORMAT_RAW;
+
+        // Open output stream
+        $stream = fopen('php://output', 'w');
+
+        // Create a CSV writer instance
+        $csv = Writer::createFromStream($stream);
+
+        $csv->insertOne(['location', 'item', 'description', 'action', 'amount', 'notes']);
+
+        foreach ($inventoryQuery->each() as $row) {
+            $data = [
+                $row['inventoryLocationId'],
+                $row['sku'],
+                $row['description'],
+                'set',
+                $row['onHandTotal'],
+                '',
+            ];
+            $csv->insertOne($data);
+        }
+
+        // Close the stream (optional, but good practice)
+        fclose($stream);
+
+        // End the response to prevent further output
+        Craft::$app->end();
+    }
+
+    public function actionExampleTemplate()
+    {
+        // return csv example template
+        $this->requirePermission('commerce-manageInventoryStockLevels');
+
+        $csvFile = Writer::createFromString('location,item,action,amount,notes');
+
+        return Craft::$app->getResponse()->sendContentAsFile(
+            $csvFile->toString(),
+            Craft::t('commerce', 'inventory-import-template') . '.csv',
+            ['mimeType' => 'text/csv']
+        );
+    }
+
+    /**
+     * Upload a file to a temporary directory
+     *
+     * @return Response
+     */
+    public function actionUploadTempFile(): Response
+    {
+        $this->requirePostRequest();
+        $this->requirePermission('commerce-manageInventoryStockLevels');
+        $this->requireAcceptsJson();
+
+        $file = UploadedFile::getInstanceByName('file');
+
+        if (!$file) {
+            return $this->asFailure(Craft::t('commerce', 'No file uploaded'));
+        }
+
+        // Check file type
+        if ($file->extension !== 'csv') {
+            return $this->asFailure(Craft::t('commerce', 'Only CSV files are allowed'));
+        }
+
+        // Create temp directory if it doesn't exist
+        $tempDirectory = Craft::$app->getPath()->getTempPath() . '/commerce-inventory-import';
+        if (!is_dir($tempDirectory)) {
+            mkdir($tempDirectory, 0777, true);
+        }
+
+        // Generate unique filename
+        $filename = 'inventory-import-' . uniqid() . '.csv';
+        $tempPath = $tempDirectory . '/' . $filename;
+
+        // Save the file
+        if (!$file->saveAs($tempPath)) {
+            return $this->asFailure(Craft::t('commerce', 'Could not save the file'));
+        }
+
+        return $this->asJson([
+            'success' => true,
+            'filename' => $filename,
+        ]);
+    }
+}

src/elements/traits/OrderValidatorsTrait.php

@@ -83,7 +83,7 @@ public function validateAddress(string $attribute): void
         // Set live scenario for addresses to match CP
         $address?->setScenario(Address::SCENARIO_LIVE);
 
-        if ($address && !$address->validate()) {
+        if ($address && (!$address->validate())) {
             $this->addModelErrors($address, $attribute);
         }