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 readonly 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,57 @@
+{% 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 %}
+    <span>{{ ibexa_content_name(content) }}</span>
+    <code>{{ product.code }}</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>
+                    <span>{{ variant.name }}</span>
+                    <code>{{ variant.code }}</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 %}
+    <div style="display: inline-block;">
+        <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; position: absolute; background: #fff;">
+            {{ component }}
+        </div>
+    </div>
+{% endmacro %}

code_samples/shopping_list/add_to_shopping_list/webpack.config.js

@@ -0,0 +1,61 @@
+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'),
+        '@ibexa-admin-ui': path.resolve('./vendor/ibexa/admin-ui'), // @ibexa-admin-ui/…/text.helper dependency
+    })
+    .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/schema.mysql.sql

@@ -0,0 +1,32 @@
+CREATE TABLE ibexa_shopping_list (
+  id INT AUTO_INCREMENT NOT NULL,
+  owner_id INT NOT NULL,
+  identifier CHAR(36) NOT NULL COMMENT '(DC2Type:guid)',
+  name VARCHAR(190) DEFAULT NULL,
+  created_at DATETIME NOT NULL COMMENT '(DC2Type:datetime_immutable)',
+  updated_at DATETIME NOT NULL COMMENT '(DC2Type:datetime_immutable)',
+  is_default TINYINT(1) DEFAULT 0 NOT NULL,
+  UNIQUE INDEX ibexa_shopping_list_identifier_idx (identifier),
+  INDEX ibexa_shopping_list_owner_idx (owner_id),
+  INDEX ibexa_shopping_list_default_idx (is_default),
+  PRIMARY KEY(id)
+) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_520_ci` ENGINE = InnoDB;
+CREATE TABLE ibexa_shopping_list_entry (
+  id INT AUTO_INCREMENT NOT NULL,
+  shopping_list_id INT NOT NULL,
+  product_code VARCHAR(64) NOT NULL,
+  identifier CHAR(36) NOT NULL COMMENT '(DC2Type:guid)',
+  added_at DATETIME NOT NULL COMMENT '(DC2Type:datetime_immutable)',
+  UNIQUE INDEX ibexa_shopping_list_entry_identifier_idx (identifier),
+  INDEX ibexa_shopping_list_entry_list_idx (shopping_list_id),
+  INDEX ibexa_shopping_list_entry_product_idx (product_code),
+  INDEX ibexa_shopping_list_entry_added_at_idx (added_at),
+  UNIQUE INDEX ibexa_shopping_list_entry_unique (shopping_list_id, product_code),
+  PRIMARY KEY(id)
+) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_520_ci` ENGINE = InnoDB;
+ALTER TABLE ibexa_shopping_list
+  ADD CONSTRAINT ibexa_shopping_list_owner_fk FOREIGN KEY (owner_id) REFERENCES ibexa_user (contentobject_id) ON UPDATE CASCADE ON DELETE CASCADE;
+ALTER TABLE ibexa_shopping_list_entry
+  ADD CONSTRAINT ibexa_shopping_list_entry_list_fk FOREIGN KEY (shopping_list_id) REFERENCES ibexa_shopping_list (id) ON UPDATE CASCADE ON DELETE CASCADE;
+ALTER TABLE ibexa_shopping_list_entry
+  ADD CONSTRAINT ibexa_shopping_list_entry_product_fk FOREIGN KEY (product_code) REFERENCES ibexa_product (code) ON UPDATE CASCADE ON DELETE CASCADE;

code_samples/shopping_list/install/schema.postgresql.sql

@@ -0,0 +1,35 @@
+CREATE TABLE ibexa_shopping_list (
+  id SERIAL NOT NULL,
+  owner_id INT NOT NULL,
+  identifier UUID NOT NULL,
+  name VARCHAR(190) DEFAULT NULL,
+  created_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL,
+  updated_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL,
+  is_default BOOLEAN DEFAULT false NOT NULL,
+  PRIMARY KEY (id)
+);
+CREATE UNIQUE INDEX ibexa_shopping_list_identifier_idx ON ibexa_shopping_list (identifier);
+CREATE INDEX ibexa_shopping_list_owner_idx ON ibexa_shopping_list (owner_id);
+CREATE INDEX ibexa_shopping_list_default_idx ON ibexa_shopping_list (is_default);
+COMMENT ON COLUMN ibexa_shopping_list.created_at IS '(DC2Type:datetime_immutable)';
+COMMENT ON COLUMN ibexa_shopping_list.updated_at IS '(DC2Type:datetime_immutable)';
+CREATE TABLE ibexa_shopping_list_entry (
+  id SERIAL NOT NULL,
+  shopping_list_id INT NOT NULL,
+  product_code VARCHAR(64) NOT NULL,
+  identifier UUID NOT NULL,
+  added_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL,
+  PRIMARY KEY (id)
+);
+CREATE UNIQUE INDEX ibexa_shopping_list_entry_identifier_idx ON ibexa_shopping_list_entry (identifier);
+CREATE INDEX ibexa_shopping_list_entry_list_idx ON ibexa_shopping_list_entry (shopping_list_id);
+CREATE INDEX ibexa_shopping_list_entry_product_idx ON ibexa_shopping_list_entry (product_code);
+CREATE INDEX ibexa_shopping_list_entry_added_at_idx ON ibexa_shopping_list_entry (added_at);
+CREATE UNIQUE INDEX ibexa_shopping_list_entry_unique ON ibexa_shopping_list_entry (shopping_list_id, product_code);
+COMMENT ON COLUMN ibexa_shopping_list_entry.added_at IS '(DC2Type:datetime_immutable)';
+ALTER TABLE ibexa_shopping_list
+  ADD CONSTRAINT ibexa_shopping_list_owner_fk FOREIGN KEY (owner_id) REFERENCES ibexa_user (contentobject_id) ON UPDATE CASCADE ON DELETE CASCADE NOT DEFERRABLE INITIALLY IMMEDIATE;
+ALTER TABLE ibexa_shopping_list_entry
+  ADD CONSTRAINT ibexa_shopping_list_entry_list_fk FOREIGN KEY (shopping_list_id) REFERENCES ibexa_shopping_list (id) ON UPDATE CASCADE ON DELETE CASCADE NOT DEFERRABLE INITIALLY IMMEDIATE;
+ALTER TABLE ibexa_shopping_list_entry
+  ADD CONSTRAINT ibexa_shopping_list_entry_product_fk FOREIGN KEY (product_code) REFERENCES ibexa_product (code) ON UPDATE CASCADE ON DELETE CASCADE NOT DEFERRABLE INITIALLY IMMEDIATE;

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/ShoppingListFilterCommand.php

@@ -0,0 +1,69 @@
+<?php declare(strict_types=1);
+
+namespace App\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:filter', description: 'Test Shopping List duplicate entry filtering before addition')]
+class ShoppingListFilterCommand extends Command
+{
+    public function __construct(
+        private readonly UserService $userService,
+        private readonly PermissionResolver $permissionResolver,
+        private readonly ShoppingListServiceInterface $shoppingListService
+    ) {
+        parent::__construct();
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $login = 'admin';
+        $desiredProductCodes = ['TODO', 'TODO'];
+        $name = 'shopping-list-test-filtering';
+
+        $user = $this->userService->loadUserByLogin($login);
+        $this->permissionResolver->setCurrentUserReference($user);
+
+        $list = $this->shoppingListService->createShoppingList(new ShoppingListCreateStruct($name));
+
+        $list = $this->shoppingListService->addEntries($list, [new EntryAddStruct($desiredProductCodes[1])]);
+
+        $filteredProductCodes = array_filter(
+            $desiredProductCodes,
+            static fn ($productCode): bool => !$list->getEntries()->hasEntryWithProductCode($productCode)
+        );
+        $list = $this->shoppingListService->addEntries(
+            $list,
+            array_map(
+                static fn ($productCode): EntryAddStruct => new EntryAddStruct($productCode),
+                $filteredProductCodes
+            )
+        );
+
+        $this->displayList($output, $list);
+
+        $this->shoppingListService->deleteShoppingList($list);
+
+        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>");
+        }
+    }
+}