BitBagCommerce · mpysiak · Jul 12, 2024 · Jul 12, 2024 · Jul 12, 2024 · Jul 15, 2024
diff --git a/README.md b/README.md
@@ -1,126 +1,47 @@
 # [![](https://bitbag.io/wp-content/uploads/2021/01/CMS.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_cms)
 
-# BitBag SyliusCMSPlugin
+# SyliusCMSPlugin
 
 ----
 
 [![](https://img.shields.io/packagist/l/bitbag/cms-plugin.svg) ](https://packagist.org/packages/bitbag/cms-plugin "License") [ ![](https://img.shields.io/packagist/v/bitbag/cms-plugin.svg) ](https://packagist.org/packages/bitbag/cms-plugin "Version") [ ![](https://img.shields.io/github/actions/workflow/status/BitBagCommerce/SyliusCmsPlugin/build.yml) ](https://github.com/BitBagCommerce/SyliusCmsPlugin/actions "Build status") [ ![](https://img.shields.io/scrutinizer/g/BitBagCommerce/SyliusCMSPlugin.svg) ](https://scrutinizer-ci.com/g/BitBagCommerce/SyliusCMSPlugin/ "Scrutinizer") [![](https://poser.pugx.org/bitbag/cms-plugin/downloads)](https://packagist.org/packages/bitbag/cms-plugin "Total Downloads") [![Slack](https://img.shields.io/badge/community%20chat-slack-FF1493.svg)](http://sylius-devs.slack.com) [![Support](https://img.shields.io/badge/support-contact%20author-blue])](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_cms)
 
-<p>
- <img align="left" src="https://sylius.com/assets/badge-approved-by-sylius.png" width="85">
-</p> 
-
-At BitBag we do believe in open source. However, we are able to do it just because of our awesome clients, who are kind enough to share some parts of our work with the community. Therefore, if you feel like there is a possibility for us to work  together, feel free to reach out. You will find out more about our professional services, technologies, and contact details at [https://bitbag.io/](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_cms).
-
-Like what we do? Want to join us? Check out our job listings on our [career page](https://bitbag.io/career/?utm_source=github&utm_medium=referral&utm_campaign=career). Not familiar with Symfony & Sylius yet, but still want to start with us? Join our [academy](https://bitbag.io/pl/akademia?utm_source=github&utm_medium=url&utm_campaign=akademia)!
-
-## Table of Content
-
-***
-
-* [Overview](#overview)
-* [Support](#we-are-here-to-help)
-* [About us](#about-us)
-    * [Community](#community)
-* [Demo](#demo-sylius-shop)
-* [License](#license)
-* [Contact](#contact)
-
 # Overview
 
 ***
 
-Almost every eCommerce app has to present some content. Managing it is often done via third-party libraries like WordPress, eZ Platform, or a built-in content management system. As Sylius does not have a CMS in the standard platform, we decided to develop our own, which will be as flexible as Sylius. This plugin allows you to add dynamic blocks with images, text or HTML to your storefront, as well as pages and FAQs section.
-<img align="left" src="https://bitbag.io/wp-content/uploads/2021/01/Sylius-CMS-Plugin-Building-Block-1-1024x1024.png">
+Almost every eCommerce app has to present some content. Managing it is often done via third-party libraries like WordPress, 
+eZ Platform, or a built-in content management system. As Sylius does not have a CMS in the standard platform, 
+we decided to develop our own, which will be as flexible as Sylius. This plugin allows you to add dynamic blocks and pages
+with content elements to your storefront.
 
 - [Use Case](doc/use_case.md)
+  - [Collections](doc/use_case_collections.md)
+  - [Content Templates](doc/use_case_content_templates.md)
+  - [Pages](doc/use_case_pages.md)
+  - [Blocks](doc/use_case_blocks.md)
+  - [Media](doc/use_case_media.md)
 - [Installation](doc/installation.md)
 - [Upgrading](UPGRADE.md)
-- [Blocks](doc/blocks.md)
+- [Collections](doc/collections.md)
+- [Content Templates](doc/content_templates.md)
 - [Pages](doc/pages.md)
-- [Sections](doc/sections.md)
+- [Blocks](doc/blocks.md)
+- [Page/Block templates](doc/templates.md)
 - [Media](doc/media.md)
-- [FAQs](doc/faqs.md)
 - [Fixtures](doc/fixtures.md)
 - [WYSIWYG](doc/wysiwyg.md)
 - [Importing resources](doc/importing-resources.md)
-- [Using Twig functions in the admin panel](doc/twig-functions-in-admin.md)
+- [Legacy data migration](doc/legacy_data_migration.md)
 - [Sitemap](doc/sitemap.md)
 - [Customization](doc/customization.md)
 
-## We are here to help
-This **open-source plugin was developed to help the Sylius community**. If you have any additional questions, would like help with installing or configuring the plugin, or need any assistance with your Sylius project - let us know!
-
-[![](https://bitbag.io/wp-content/uploads/2020/10/button-contact.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_cms)
-
-Read more about  [Sylius  CMS](https://bitbag.io/sylius-cms-all-you-need-to-know-3-implementation-methods/?utm_source=github&utm_medium=referral&utm_campaign=plugins_cms)
-
-# About us
-
----
-
-BitBag is a company of people who **love what they do** and do it right. We fulfill the eCommerce technology stack with **Sylius**, Shopware, Akeneo, and Pimcore for PIM, eZ Platform for CMS, and VueStorefront for PWA. Our goal is to provide real digital transformation with an agile solution that scales with the **clients’ needs**. Our main area of expertise includes eCommerce consulting and development for B2C, B2B, and Multi-vendor Marketplaces.</br>
-We are advisers in the first place. We start each project with a diagnosis of problems, and an analysis of the needs and **goals** that the client wants to achieve.</br>
-We build **unforgettable**, consistent digital customer journeys on top of the **best technologies**. Based on a detailed analysis of the goals and needs of a given organization, we create dedicated systems and applications that let businesses grow.<br>
-Our team is fluent in **Polish, English, German and, French**. That is why our cooperation with clients from all over the world is smooth.
-
-**Some numbers from BitBag regarding Sylius:**
- - 50+ **experts** including consultants, UI/UX designers, Sylius trained front-end and back-end developers,
- - 120+ projects **delivered** on top of Sylius,
- - 25+ **countries** of BitBag’s customers,
- - 4+ **years** in the Sylius ecosystem.
-
-**Our services:**
- - Business audit/Consulting in the field of **strategy** development,
- - Data/shop **migration**,
- - Headless **eCommerce**,
- - Personalized **software** development,
- - **Project** maintenance and long term support,
- - Technical **support**.
-
-**Key clients:** Mollie, Guave, P24, Folkstar, i-LUNCH, Elvi Project, WestCoast Gifts.
-
----
-
-If you need some help with Sylius development, don't be hesitated to contact us directly. You can fill the form on [this site](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_cms) or send us an e-mail at [email protected]!
-
----
-
-[![](https://bitbag.io/wp-content/uploads/2021/08/sylius-badges-transparent-wide.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_cms)
-
 ## Community
 
 ---- 
 
 For online communication, we invite you to chat with us & other users on [Sylius Slack](https://sylius-devs.slack.com/).
 
-# Demo Sylius Shop
-
----
-
-We created a demo app with some useful use-cases of plugins!
-Visit [sylius-demo.bitbag.io](https://sylius-demo.bitbag.io/) to take a look at it. The admin can be accessed under
-[sylius-demo.bitbag.io/admin/login](https://sylius-demo.bitbag.io/admin/login) link and `bitbag: bitbag` credentials.
-Plugins that we have used in the demo:
-
-| BitBag's Plugin | GitHub | Sylius' Store|
-| ------ | ------ | ------|
-| ACL Plugin | *Private. Available after the purchasing.*| https://plugins.sylius.com/plugin/access-control-layer-plugin/|
-| Braintree Plugin | https://github.com/BitBagCommerce/SyliusBraintreePlugin |https://plugins.sylius.com/plugin/braintree-plugin/|
-| CMS Plugin | https://github.com/BitBagCommerce/SyliusCmsPlugin | https://plugins.sylius.com/plugin/cmsplugin/|
-| Elasticsearch Plugin | https://github.com/BitBagCommerce/SyliusElasticsearchPlugin | https://plugins.sylius.com/plugin/2004/|
-| Mailchimp Plugin | https://github.com/BitBagCommerce/SyliusMailChimpPlugin | https://plugins.sylius.com/plugin/mailchimp/ |
-| Multisafepay Plugin | https://github.com/BitBagCommerce/SyliusMultiSafepayPlugin |
-| Wishlist Plugin | https://github.com/BitBagCommerce/SyliusWishlistPlugin | https://plugins.sylius.com/plugin/wishlist-plugin/|
-| **Sylius' Plugin** | **GitHub** | **Sylius' Store** |
-| Admin Order Creation Plugin | https://github.com/Sylius/AdminOrderCreationPlugin | https://plugins.sylius.com/plugin/admin-order-creation-plugin/ |
-| Invoicing Plugin | https://github.com/Sylius/InvoicingPlugin | https://plugins.sylius.com/plugin/invoicing-plugin/ |
-| Refund Plugin | https://github.com/Sylius/RefundPlugin | https://plugins.sylius.com/plugin/refund-plugin/ |
-
-**If you need an overview of Sylius' capabilities, schedule a consultation with our expert.**
-
-[![](https://bitbag.io/wp-content/uploads/2020/10/button_free_consulatation-1.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_cms)
-
 ## Additional resources for developers
 
 ---
@@ -137,10 +58,3 @@ To learn more about our contribution workflow and more, we encourage you to use
 This plugin's source code is completely free and released under the terms of the MIT license.
 
 [//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen.)
-
-## Contact
-
----
-If you want to contact us, the best way is to fill the form on [our website](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_cms) or send us an e-mail to [email protected] with your question(s). We guarantee that we answer as soon as we can!
-
-[![](https://bitbag.io/wp-content/uploads/2021/08/badges-bitbag.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_cms)
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -0,0 +1,105 @@
+# UPGRADE FROM 4.2 TO 5.0
+
+This upgrade is a major one, as it introduces a new feature - [Content Elements](doc/content_elements.md)
+and removes the old way of creating blocks and pages.
+
+* A lot of database modifications has been made. Read the below changelog first and then migrate your structure using
+  `bin/console doctrine:migrations:diff && bin/console doctrine:migrations:migrate` commands.
+* Sections are now Collections, as it was a more suitable name for the feature.
+* Pages and Blocks now have `Content elements` segment, where you can add elements to the page or block.
+* Removed FAQ, as you can now create a FAQ page with the new content elements.
+* Added new `Content Templates` section where you can create templates for your content elements. Read more about it in [Use case content templates](doc/use_case_content_templates.md)
+and [Content Templates](doc/content_templates.md) docs.
+* Removed CKEditor deprecation modal.
+* Reordered forms/elements for functionality consistency.
+* Updated import functionality to work with the new structure.
+* Updated fixtures to work with the new structure
+* Removed `sylius_cms_render_product_pages` twig extension.
+* Removed support for rendering twig functions in WYSIWYG editor.
+* Added twig extensions: 
+  * `sylius_cms_render_collection`
+  * `sylius_cms_render_content_elements`
+
+## Briefly about Content Elements
+
+Content elements is a new segment in the block/page form where you can add elements that will be rendered on the store's frontend, like:
+* Textarea
+* Heading
+* Images
+* Products carousel
+* etc.
+
+> Read more about the content elements in the updated [Content elements](doc/content_elements.md) doc.
+
+## Changes in Collections (old Sections)
+
+### Added fields:
+
+* Type
+* Pages/Block/Media (depending on the chosen type)
+
+### Moved fields:
+
+* Name field has been moved from translations to the main settings tab
+
+> Read more about the collections in the updated [Use case collections](doc/use_case_collections.md) and [Collections](doc/collections.md) docs.
+
+## Changes in Pages
+
+### Removed fields:
+
+* Products
+* Breadcrumb
+* Name when linked
+* Description when linked
+* Image
+* Content
+* Title
+
+### Added fields
+
+* Teaser title
+* Teaser content
+* Teaser image
+
+### Moved fields
+
+* Name field has been moved from translations to the main settings tab
+
+> Read more about the pages in the updated [Use case pages](doc/use_case_pages.md) and [Pages](doc/pages.md) docs.
+
+## Changes in Blocks
+
+### Removed fields:
+
+* Products
+* Taxons
+* Whole translations tab
+
+### Added fields
+
+* Name
+* Locales
+* Display for products
+* Display for products in taxons
+* Display for taxons
+
+> Read more about the blocks in the updated [Use case blocks](doc/use_case_blocks.md) and [Blocks](doc/blocks.md) docs.
+
+## Changes in Media
+
+### Removed fields:
+
+* Products
+
+### Added fields
+
+* Media preview with path
+
+### Moved fields
+
+* Name field has been moved from translations to the main settings tab
+
+### Renamed fields
+
+* Content -> Link content
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -19,7 +19,7 @@ structure using `bin/console doctrine:migrations:diff && bin/console doctrine:mi
 use raw content in [WYSIWYG editor](doc/wysiwyg.md)
 * Chanel awareness has been added to pages, blocks, FAQs, sections and media. That being said, many
 repository methods changed their signatures. In case you customized them in your src, check 
-new signatures in interfaces under [BitBag\SyliusCmsPlugin\Repository](src/Repository) namespace
+new signatures in interfaces under [Sylius\CmsPlugin\Repository](src/Repository) namespace
 * WYSIWYG editor has been introduced. You will need to import it in your AppKernel and install 
 its assets. For more, check the [installation guide](doc/installation.md)
 * Sitemap support was added, you will need to enable extra bundle in your AppKernel. Read more

diff --git a/behat.yml.dist b/behat.yml.dist
@@ -47,7 +47,7 @@ default:
         FriendsOfBehat\SymfonyExtension:
             bootstrap: tests/Application/config/bootstrap.php
             kernel:
-                class: Tests\BitBag\SyliusCmsPlugin\Application\Kernel
+                class: Tests\Sylius\CmsPlugin\Application\Kernel
 
         FriendsOfBehat\VariadicExtension: ~
 

diff --git a/composer.json b/composer.json
@@ -9,11 +9,10 @@
   "description": "CMS plugin for Sylius applications.",
   "license": "MIT",
   "require": {
-    "php": "^8.0",
+    "php": "^8.1",
     "sylius/sylius": "^1.12.0 || ^1.13.0",
     "league/csv": "^9.1",
     "friendsofsymfony/ckeditor-bundle": "^2.0",
-    "instaclick/php-webdriver": "^1.4",
     "symfony/webpack-encore-bundle": "^1.12"
   },
   "require-dev": {
@@ -31,6 +30,7 @@
     "friends-of-behat/suite-settings-extension": "^1.0",
     "friends-of-behat/symfony-extension": "^2.1",
     "friends-of-behat/variadic-extension": "^1.3",
+    "instaclick/php-webdriver": "^1.4",
     "lchrusciel/api-test-case": "^4.1 || ^5.0",
     "matthiasnoback/symfony-config-test": "^5.1",
     "phpspec/phpspec": "^7.2",
@@ -51,26 +51,19 @@
     "symfony/runtime": "^5.4 || ^6.4",
     "symfony/web-profiler-bundle": "^5.4 || ^6.4"
   },
-  "conflict": {
-    "symfony/symfony": "4.1.8",
-    "symfony/browser-kit": "4.1.8",
-    "symfony/dom-crawler": "4.1.8",
-    "symfony/routing": "4.1.8",
-    "symfony/doctrine-bridge": "4.4.16"
-  },
   "suggest": {
-    "stefandoorn/sitemap-plugin": "^2.0@alpha"
+    "stefandoorn/sitemap-plugin": "^2.2"
   },
   "prefer-stable": true,
   "autoload": {
     "psr-4": {
-      "BitBag\\SyliusCmsPlugin\\": "src/",
-      "Tests\\BitBag\\SyliusCmsPlugin\\": "tests/"
+      "Sylius\\CmsPlugin\\": "src/",
+      "Tests\\Sylius\\CmsPlugin\\": "tests/"
     }
   },
   "autoload-dev": {
     "psr-4": {
-      "spec\\BitBag\\SyliusCmsPlugin\\": "spec/"
+      "spec\\Sylius\\CmsPlugin\\": "spec/"
     },
     "classmap": ["tests/Application/Kernel.php"]
   },

diff --git a/doc/01.1-webpack-config.md b/doc/01.1-webpack-config.md
@@ -1,4 +1,4 @@
-# BitBag SyliusCmsPlugin
+# SyliusCmsPlugin
 
 - [⬅️ Back](./installation.md)
 
@@ -13,10 +13,10 @@
 
 ```js
 // webpack.config.js
-const [ bitbagCmsShop, bitbagCmsAdmin ] = require('./vendor/bitbag/cms-plugin/webpack.config.js')
+const [ cmsShop, cmsAdmin ] = require('./vendor/bitbag/cms-plugin/webpack.config.js')
 ...
 
-module.exports = [..., bitbagCmsShop, bitbagCmsAdmin];
+module.exports = [..., cmsShop, cmsAdmin];
 ```
 
 2. Add new packages in `./config/packages/assets.yaml`
@@ -29,9 +29,9 @@ framework:
         packages:
             # ...
             cms_shop:
-                json_manifest_path: '%kernel.project_dir%/public/build/bitbag/cms/shop/manifest.json'
+                json_manifest_path: '%kernel.project_dir%/public/build/cms/shop/manifest.json'
             cms_admin:
-                json_manifest_path: '%kernel.project_dir%/public/build/bitbag/cms/admin/manifest.json'
+                json_manifest_path: '%kernel.project_dir%/public/build/cms/admin/manifest.json'
 ```
 
 3. Add new build paths in `./config/packages/webpack_encore.yml`
@@ -42,24 +42,24 @@ framework:
 webpack_encore:
     builds:
         # ...
-        cms_shop: '%kernel.project_dir%/public/build/bitbag/cms/shop'
-        cms_admin: '%kernel.project_dir%/public/build/bitbag/cms/admin'
+        cms_shop: '%kernel.project_dir%/public/build/cms/shop'
+        cms_admin: '%kernel.project_dir%/public/build/cms/admin'
 ```
 
 4. Add encore functions to your templates
 
 ```twig
 {# @SyliusShopBundle/_scripts.html.twig #}
-{{ encore_entry_script_tags('bitbag-cms-shop', null, 'cms_shop') }}
+{{ encore_entry_script_tags('sylius-cms-shop', null, 'cms_shop') }}
 
 {# @SyliusShopBundle/_styles.html.twig #}
-{{ encore_entry_link_tags('bitbag-cms-shop', null, 'cms_shop') }}
+{{ encore_entry_link_tags('sylius-cms-shop', null, 'cms_shop') }}
 
 {# @SyliusAdminBundle/_scripts.html.twig #}
-{{ encore_entry_script_tags('bitbag-cms-admin', null, 'cms_admin') }}
+{{ encore_entry_script_tags('sylius-cms-admin', null, 'cms_admin') }}
 
 {# @SyliusAdminBundle/_styles.html.twig #}
-{{ encore_entry_link_tags('bitbag-cms-admin', null, 'cms_admin') }}
+{{ encore_entry_link_tags('sylius-cms-admin', null, 'cms_admin') }}
 ```
 
 5. Run `yarn encore dev` or `yarn encore production`