Shopping list

code_samples/shopping_list/add_to_shopping_list/assets/js/add-to-shopping-list.ts

@@ -0,0 +1,18 @@
+// Shopping list service
+import ShoppingList from '@ibexa-shopping-list/src/bundle/Resources/public/js/component/shopping.list';
+// The Add to shopping list interaction
+import { AddToShoppingList } from '@ibexa-shopping-list/src/bundle/Resources/public/js/component/add.to.shopping.list';
+// List of all user's shopping lists
+import { ShoppingListsList } from '@ibexa-shopping-list/src/bundle/Resources/public/js/component/shopping.lists.list';
+
+(function (global: Window, doc: Document) {
+    const shoppingList = new ShoppingList();
+    shoppingList.init(); // Fetch user's shopping lists
+
+    const addToShoppingListsNodes = doc.querySelectorAll<HTMLDivElement>('.ibexa-sl-add-to-shopping-list');
+    addToShoppingListsNodes.forEach((addToShoppingListNode) => {
+        const addToShoppingList = new AddToShoppingList({ node: addToShoppingListNode, ListClass: ShoppingListsList });
+
+        addToShoppingList.init();
+    });
+})(window, window.document);

code_samples/shopping_list/add_to_shopping_list/config/packages/views.yaml

@@ -0,0 +1,10 @@
+ibexa:
+    system:
+        default:
+            content_view:
+                full:
+                    product:
+                        controller: 'App\Controller\ProductViewController::viewAction'
+                        template: '@ibexadesign/full/product.html.twig'
+                        match:
+                            '@Ibexa\Contracts\ProductCatalog\ViewMatcher\ProductBased\IsProduct': true

code_samples/shopping_list/add_to_shopping_list/src/Controller/ProductViewController.php

@@ -0,0 +1,35 @@
+<?php declare(strict_types=1);
+
+namespace App\Controller;
+
+use Ibexa\Contracts\Core\Repository\Iterator\BatchIterator;
+use Ibexa\Contracts\ProductCatalog\Iterator\BatchIteratorAdapter\ProductVariantFetchAdapter;
+use Ibexa\Contracts\ProductCatalog\Local\LocalProductServiceInterface;
+use Ibexa\Contracts\ProductCatalog\Values\Product\ProductVariantQuery;
+use Ibexa\Core\MVC\Symfony\View\ContentView;
+use Ibexa\Core\MVC\Symfony\View\View;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Request;
+
+class ProductViewController extends AbstractController
+{
+    public function __construct(private LocalProductServiceInterface $productService)
+    {
+    }
+
+    public function viewAction(Request $request, ContentView $view): View
+    {
+        $product = $this->productService->getProductFromContent($view->getContent());
+        if ($product->isBaseProduct()) {
+            $view->addParameters([
+                'variants' => new BatchIterator(new ProductVariantFetchAdapter(
+                    $this->productService,
+                    $product,
+                    new ProductVariantQuery(),
+                )),
+            ]);
+        }
+
+        return $view;
+    }
+}

code_samples/shopping_list/add_to_shopping_list/templates/themes/standard/full/product.html.twig

@@ -0,0 +1,56 @@
+{% extends '@ibexadesign/pagelayout.html.twig' %}
+
+{% set product = content|ibexa_get_product %}
+
+{% block meta %}
+    {% set token = csrf_token ?? csrf_token(ibexa_get_rest_csrf_token_intention()) %}
+    <meta name="CSRF-Token" content="{{ token }}"/>
+    <meta name="SiteAccess" content="{{ app.request.get('siteaccess').name }}"/>
+{% endblock %}
+
+{% block content %}
+    {{ ibexa_content_name(content) }}
+    {{ product.code }}
+    {% if not product.isBaseProduct() and can_view_shopping_list and can_edit_shopping_list %}
+        {% set component %}
+            {% include '@ibexadesign/shopping_list/component/add_to_shopping_list/add_to_shopping_list.html.twig' with {
+                product_code: product.code,
+            } %}
+        {% endset %}
+        {{ _self.add_to_shopping_list(product, component) }}
+    {% endif %}
+
+    {% if product.isBaseProduct() %}
+        <ul>
+            {% for variant in variants %}
+                <li>
+                    {{ variant.name }}
+                    {{ variant.code }}
+                    {% if can_view_shopping_list and can_edit_shopping_list %}
+                        {% set component %}
+                            {% include '@ibexadesign/shopping_list/component/add_to_shopping_list/add_to_shopping_list.html.twig' with {
+                                product_code: variant.code,
+                            } %}
+                        {% endset %}
+                        {{ _self.add_to_shopping_list(variant, component) }}
+                    {% endif %}
+                </li>
+            {% endfor %}
+        </ul>
+    {% endif %}
+{% endblock %}
+
+{% block javascripts %}
+    {{ encore_entry_script_tags('add-to-shopping-list-js') }}
+{% endblock %}
+
+{% macro add_to_shopping_list(product, component) %}
+    {% set widget_id = 'add-to-shopping-list-' ~ product.code|slug %}
+    <button
+            onclick="(function(){let e=document.getElementById('{{ widget_id }}'); e.style.display=('none'===window.getComputedStyle(e).display)?'block':'none';})()">
+        Add to shopping list
+    </button>
+    <div id="{{ widget_id }}" style="display: none;">
+        {{ component }}
+    </div>
+{% endmacro %}

code_samples/shopping_list/add_to_shopping_list/webpack.config.js

@@ -0,0 +1,60 @@
+const fs = require('fs');
+const path = require('path');
+const Encore = require('@symfony/webpack-encore');
+const getWebpackConfigs = require('@ibexa/frontend-config/webpack-config/get-configs');
+const customConfigsPaths = require('./var/encore/ibexa.webpack.custom.config.js');
+
+const customConfigs = getWebpackConfigs(Encore, customConfigsPaths);
+const isReactBlockPathCreated = fs.existsSync('./assets/page-builder/react/blocks');
+
+Encore.reset();
+Encore
+    .setOutputPath('public/build/')
+    .setPublicPath('/build')
+    .enableSassLoader()
+    .enableReactPreset((options) => {
+        options.runtime = 'classic';
+    })
+    .enableSingleRuntimeChunk()
+    .copyFiles({
+        from: './assets/images',
+        to: 'images/[path][name].[ext]',
+        pattern: /\.(png|svg)$/,
+    })
+    .configureBabelPresetEnv((config) => {
+        config.useBuiltIns = 'usage';
+        config.corejs = 3;
+    });
+
+// Welcome page stylesheets
+Encore.addEntry('welcome-page-css', [
+    path.resolve(__dirname, './assets/scss/welcome-page.scss'),
+]);
+
+// Welcome page javascripts
+Encore.addEntry('welcome-page-js', [
+    path.resolve(__dirname, './assets/js/welcome.page.js'),
+]);
+
+if (isReactBlockPathCreated) {
+    // React Blocks javascript
+    Encore.addEntry('react-blocks-js', './assets/js/react.blocks.js');
+}
+
+//Encore.addEntry('app', './assets/app.js');
+
+Encore
+    .enableTypeScriptLoader()
+    .addAliases({
+        '@ibexa-shopping-list': path.resolve('./vendor/ibexa/shopping-list'),
+    })
+    .addEntry('add-to-shopping-list-js', [
+        path.resolve(__dirname, './assets/js/add-to-shopping-list.ts'),
+    ])
+;
+
+const projectConfig = Encore.getWebpackConfig();
+
+projectConfig.name = 'app';
+
+module.exports = [...customConfigs, projectConfig];

code_samples/shopping_list/install/src/Migrations/Ibexa/migrations/shopping_list_user.yaml

@@ -0,0 +1,33 @@
+-   type: reference
+    mode: load
+    filename: references/customer_group_references.yml
+
+-   type: role
+    mode: create
+    metadata:
+        identifier: Shopping List User
+    policies:
+        -   module: shopping_list
+            function: create
+            limitations:
+                -   identifier: ShoppingListOwner
+                    values: [self]
+        -   module: shopping_list
+            function: view
+            limitations:
+                -   identifier: ShoppingListOwner
+                    values: [self]
+        -   module: shopping_list
+            function: edit
+            limitations:
+                -   identifier: ShoppingListOwner
+                    values: [self]
+        -   module: shopping_list
+            function: delete
+            limitations:
+                -   identifier: ShoppingListOwner
+                    values: [self]
+    actions:
+        -   action: assign_role_to_user_group
+            value:
+                id: 'reference:ref__checkout__customers_user_group__content_id'

code_samples/shopping_list/php_api/src/Command/ShoppingListMoveCommand.php

@@ -0,0 +1,77 @@
+<?php declare(strict_types=1);
+
+namespace App\shopping_list\php_api\src\Command;
+
+use Ibexa\Contracts\Core\Repository\PermissionResolver;
+use Ibexa\Contracts\Core\Repository\UserService;
+use Ibexa\Contracts\ShoppingList\ShoppingListServiceInterface;
+use Ibexa\Contracts\ShoppingList\Value\EntryAddStruct;
+use Ibexa\Contracts\ShoppingList\Value\ShoppingListCreateStruct;
+use Ibexa\Contracts\ShoppingList\Value\ShoppingListInterface;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+#[AsCommand(name: 'app:shopping-list:move', description: 'Test move entries between shopping lists')]
+class ShoppingListMoveCommand extends Command
+{
+    public function __construct(
+        private UserService $userService,
+        private PermissionResolver $permissionResolver,
+        private ShoppingListServiceInterface $shoppingListService
+    ) {
+        parent::__construct();
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $login = 'admin';
+        $productCodes = ['TODO', 'TODO'];
+        $movedProductCodes = $productCodes;
+        $prefix = 'shopping-list-test';
+
+        $user = $this->userService->loadUserByLogin($login);
+        $this->permissionResolver->setCurrentUserReference($user);
+
+        $sourceList = $this->shoppingListService->createShoppingList(new ShoppingListCreateStruct($prefix . '-source'));
+        $targetList = $this->shoppingListService->createShoppingList(new ShoppingListCreateStruct($prefix . '-target'));
+
+        $sourceList = $this->shoppingListService->addEntries($sourceList, [new EntryAddStruct($productCodes[0]), new EntryAddStruct($productCodes[1])]);
+        $targetList = $this->shoppingListService->addEntries($targetList, [new EntryAddStruct($productCodes[1])]);
+
+        $entriesToMove = [];
+        $entriesToRemove = [];
+        foreach ($movedProductCodes as $productCode) {
+            if ($sourceList->getEntries()->hasEntryWithProductCode($productCode)) {
+                if ($targetList->getEntries()->hasEntryWithProductCode($productCode)) {
+                    $entriesToRemove[] = $sourceList->getEntries()->getEntryWithProductCode($productCode);
+                } else {
+                    $entriesToMove[] = $sourceList->getEntries()->getEntryWithProductCode($productCode);
+                }
+            }
+        }
+        $this->shoppingListService->moveEntries($targetList, $entriesToMove);
+        $targetList = $this->shoppingListService->getShoppingList($targetList->getIdentifier()); // Refresh local object from persistence
+        $sourceList = $this->shoppingListService->removeEntries($sourceList, $entriesToRemove); // Refresh local object from persistence even if $entriesToRemove is empty
+
+        $this->displayList($output, $sourceList);
+        $this->displayList($output, $targetList);
+
+        $this->shoppingListService->deleteShoppingList($sourceList);
+        $this->shoppingListService->deleteShoppingList($targetList);
+
+        return Command::SUCCESS;
+    }
+
+    private function displayList(OutputInterface $output, ShoppingListInterface $list): void
+    {
+        $output->writeln("{$list->getOwner()->getName()} ({$list->getOwner()->getLogin()})");
+        $output->writeln("{$list->getName()} ({$list->getIdentifier()})" . ($list->isDefault() ? ' [default]' : ''));
+        $entries = $list->getEntries();
+        $output->writeln(count($entries) . (count($entries) > 1 ? ' entries' : ' entry'));
+        foreach ($entries as $entry) {
+            $output->writeln("- <info>{$entry->getProduct()->getName()} ({$entry->getProduct()->getCode()})</info>");
+        }
+    }
+}

code_samples/shopping_list/php_api/src/Controller/CartShoppingListTransferController.php

@@ -0,0 +1,94 @@
+<?php declare(strict_types=1);
+
+namespace App\Controller;
+
+use Ibexa\Contracts\Cart\CartServiceInterface;
+use Ibexa\Contracts\Cart\CartShoppingListTransferServiceInterface;
+use Ibexa\Contracts\Cart\Value\CartCreateStruct;
+use Ibexa\Contracts\Cart\Value\CartQuery;
+use Ibexa\Contracts\Core\Repository\PermissionResolver;
+use Ibexa\Contracts\Core\Repository\UserService;
+use Ibexa\Contracts\ProductCatalog\CurrencyServiceInterface;
+use Ibexa\Contracts\ProductCatalog\Local\LocalProductServiceInterface;
+use Ibexa\Contracts\ShoppingList\ShoppingListServiceInterface;
+use Ibexa\Contracts\ShoppingList\Value\EntryAddStruct as ShoppingListEntryAddStruct;
+use Ibexa\Contracts\ShoppingList\Value\Query\Criterion\NameCriterion;
+use Ibexa\Contracts\ShoppingList\Value\ShoppingListCreateStruct;
+use Ibexa\Contracts\ShoppingList\Value\ShoppingListQuery;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
+
+class CartShoppingListTransferController extends AbstractController
+{
+    public function __construct(
+        private UserService $userService,
+        private PermissionResolver $permissionResolver,
+        private CurrencyServiceInterface $currencyService,
+        private CartServiceInterface $cartService,
+        private ShoppingListServiceInterface $shoppingListService,
+        private CartShoppingListTransferServiceInterface $cartShoppingListTransferService,
+        private LocalProductServiceInterface $productService
+    ) {
+    }
+
+    #[Route(
+        path: '/app-shopping-list-cart',
+        name: 'app.shopping-list.cart',
+        methods: ['GET']
+    )]
+    public function __invoke(Request $request): Response
+    {
+        $currency = 'EUR';
+        $productCode = 'TODO';
+
+        $user = $this->userService->loadUser($this->permissionResolver->getCurrentUserReference()->getUserId());
+        $name = 'cart-shopping-list-transfer-test';
+
+        $cartQuery = new CartQuery();
+        $cartQuery->setOwnerId($user->getId());
+        $cartsList = $this->cartService->findCarts($cartQuery);
+        $cart = null;
+        foreach ($cartsList->getCarts() as $cart) {
+            if ($cart->getName() === $name) {
+                break;
+            }
+            $cart = null;
+        }
+        if (null === $cart) {
+            $cart = $this->cartService->createCart(new CartCreateStruct($name, $this->currencyService->getCurrencyByCode($currency), $user));
+        }
+
+        $lists = $this->shoppingListService->findShoppingLists(new ShoppingListQuery(new NameCriterion($name)));
+        if ($lists->getTotalCount()) {
+            $list = $lists->getShoppingLists()[0];
+        } else {
+            $list = $this->shoppingListService->createShoppingList(new ShoppingListCreateStruct($name));
+        }
+
+        $this->cartService->emptyCart($cart);
+        $list = $this->shoppingListService->clearShoppingList($list);
+
+        $list = $this->shoppingListService->addEntries($list, [new ShoppingListEntryAddStruct($productCode)]);
+
+        $cart = $this->cartShoppingListTransferService->addSelectedEntriesToCart($list, [$list->getEntries()->getEntryWithProductCode($productCode)->getIdentifier()], $cart);
+
+        dump(
+            $list->getEntries()->hasEntryWithProductCode($productCode), // true as the entry is copied and not moved
+            $cart->getEntries()->hasEntryForProduct($this->productService->getProduct($productCode)) // true
+        );
+
+        $list = $this->shoppingListService->clearShoppingList($list); // Empty the list to avoid duplicate and test the move from cart
+
+        $list = $this->cartShoppingListTransferService->moveCartToShoppingList($cart, $list);
+        $cart = $this->cartService->getCart($cart->getIdentifier()); // Refresh local object from persistence
+
+        dump(
+            $list->getEntries()->hasEntryWithProductCode($productCode), // true as, after the clear, the entry is moved from cart
+            $cart->getEntries()->hasEntryForProduct($this->productService->getProduct($productCode)) // false as the entry was moved
+        );
+
+        return new Response('<html><head></head><body></body></html>');
+    }
+}

composer.json

@@ -78,6 +78,7 @@
         "ibexa/messenger": "~5.0.x-dev",
         "ibexa/collaboration": "~5.0.x-dev",
         "ibexa/share": "~5.0.x-dev",
+        "ibexa/shopping-list": "~5.0.x-dev",
         "ibexa/phpstan": "~5.0.-dev",
         "deptrac/deptrac": "^3.0"
     },