Merge pull request #217 from magento-obsessive-owls/cms-team-1-delivery

[Owls] Beta Release 7, part 2

Author: davemacaulay

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "page-builder-types"]
+	path = page-builder-types
+	url = git@github.com:magento-obsessive-owls/page-builder-types.git

README.md

@@ -23,6 +23,31 @@ We will push new beta releases once a week, including work from the backlog. We
 
 To participate in technical discussions and ask questions, join us in [Slack], where a number of Page Builder team members are present.
 
+## TypeScript
+This module utilises TypeScript within our adminhtml web directory. This requires an additional build step or watch command to be running during development on this module.
+
+We use a combination of `tsc` from TypeScript and Babel 7.* with the TypeScript env. This enables us to have fast build times for the large TypeScript code base we have.
+
+#### `npx ts:build`
+Runs a single build of all TypeScript files within the defined directory. This utilises Babel with the TypeScript present.
+
+#### `npx ts:watch`
+Runs a continuous watch of files and builds them as it detects file changes.
+
+#### `npx ts:lint`
+Runs TSLint to verify linting of all TypeScript files
+
+#### `npx ts:defs`
+Generates TypeScript definitions for the whole module to be published as a types package.
+
+#### `npx ts:errors`
+Displays any TypeScript errors currently within the code base. This utilises `tsc` with the no emit flag.
+
+#### `npx ts:errors:watch`
+Same as above but watches for file changes.
+
+#### `npx start`
+Command used to start development on this module, uses `concurrently` to spawn instances of `npx ts:watch` and `npx ts:errors:watch`.
 
 [Contribution Guide]: CONTRIBUTING.md
 [Slack]: https://magentocommeng.slack.com/messages/GANS1R4C9

app/code/Magento/PageBuilder/Block/GoogleMapsApi.php

@@ -58,7 +58,7 @@ public function getStyle(): ?string
     public function getInvalidApiKeyMessage(): \Magento\Framework\Phrase
     {
         return __(
-            "You must provide a valid <a href='%1'>Google Maps API key</a> to use a map.",
+            "You must provide a valid <a href='%1' target='_blank'>Google Maps API key</a> to use a map.",
             $this->_urlBuilder->getUrl('adminhtml/system_config/edit/section/cms', ['_fragment' => 'cms_pagebuilder'])
         );
     }

app/code/Magento/PageBuilder/Model/Config.php

@@ -10,6 +10,9 @@
 
 use Magento\Framework\App\Config\ScopeConfigInterface;
 
+/**
+ * Represents PageBuilder loaded and cached configuration data
+ */
 class Config extends \Magento\Framework\Config\Data implements \Magento\PageBuilder\Model\ConfigInterface
 {
     const IS_PAGEBUILDER_ENABLED = 'cms/pagebuilder/enabled';
@@ -36,11 +39,13 @@ public function __construct(
     }
 
     /**
+     * Return all menu sections
+     *
      * @return array
      */
-    public function getGroups() : array
+    public function getMenuSections() : array
     {
-        return $this->get('groups');
+        return $this->get('menu_sections');
     }
 
     /**

app/code/Magento/PageBuilder/Model/Config/ContentType/Converter.php

@@ -10,6 +10,9 @@
 
 use Magento\Framework\ObjectManager\Config\Mapper\ArgumentParser;
 
+/**
+ * Convert content type configuration data
+ */
 class Converter implements \Magento\Framework\Config\ConverterInterface
 {
     const DEFAULT_ATTRIBUTE_READER = 'Magento_PageBuilder/js/property/attribute-reader';
@@ -133,7 +136,7 @@ private function convertAppearanceData(\DOMElement $appearanceNode): array
         }
         $appearanceData['converters'] = $this->convertConvertersData($appearanceNode);
         $appearanceData['preview_template'] = $this->getAttributeValue($appearanceNode, 'preview_template');
-        $appearanceData['render_template'] = $this->getAttributeValue($appearanceNode, 'render_template');
+        $appearanceData['master_template'] = $this->getAttributeValue($appearanceNode, 'master_template');
         $appearanceData['reader'] = $this->getAttributeValue($appearanceNode, 'reader');
         $appearanceData['default'] = $this->getAttributeValue($appearanceNode, 'default');
         $formNode = $appearanceNode->getElementsByTagName('form')->item(0);
@@ -357,7 +360,9 @@ private function convertTag(\DOMElement $elementNode): array
     }
 
     /**
-     * @param \DOMElement $childNode
+     * Converts converter data
+     *
+     * @param \DOMElement $appearanceNode
      * @return array
      */
     private function convertConvertersData(\DOMElement $appearanceNode): array
@@ -519,11 +524,11 @@ private function isConfigNode(\DOMNode $node): bool
     /**
      * Get attribute value
      *
-     * @param $attributeNode
-     * @param $attributeName
+     * @param \DOMElement $attributeNode
+     * @param string $attributeName
      * @return string|null
      */
-    private function getAttributeValue(\DOMElement $attributeNode, $attributeName)
+    private function getAttributeValue(\DOMElement $attributeNode, string $attributeName)
     {
         return $attributeNode->hasAttribute($attributeName)
             ? $attributeNode->attributes->getNamedItem($attributeName)->nodeValue
@@ -545,8 +550,8 @@ private function extractVariableName(\DOMElement $node): string
     /**
      * Remove data from array
      *
-     * @param $searchValue
-     * @param $data
+     * @param string $searchValue
+     * @param array $data
      * @return array
      */
     private function removeDataInArray(string $searchValue, array $data): array

app/code/Magento/PageBuilder/Model/Config/Group/Converter.php

@@ -0,0 +1,53 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\PageBuilder\Model\Config\MenuSection;
+
+/**
+ * Converter for menu section in configuration
+ */
+class Converter implements \Magento\Framework\Config\ConverterInterface
+{
+    /**
+     * Convert XML structure into output array
+     *
+     * @param \DOMDocument $source
+     * @return array
+     * @throws \InvalidArgumentException
+     */
+    public function convert($source): array
+    {
+        return [
+            'menu_sections' => $this->convertMenuSections($source)
+        ];
+    }
+
+    /**
+     * Convert data for menu sections
+     *
+     * @param \DOMDocument $source
+     * @return array
+     */
+    private function convertMenuSections(\DOMDocument $source): array
+    {
+        $menuSectionsData = [];
+        /** @var \DOMNode $menuSection */
+        foreach ($source->getElementsByTagName('menu_section') as $menuSection) {
+            $name = $menuSection->attributes->getNamedItem('name')->nodeValue;
+            /** @var \DOMElement $attributeValue */
+            foreach ($menuSection->attributes as $attributeName => $attributeValue) {
+                $menuSectionsData[$name][$attributeName] = $attributeValue->nodeValue;
+            }
+        }
+        uasort($menuSectionsData, function ($firstElement, $secondElement) {
+            return (int)$firstElement['sortOrder'] <=> (int)$secondElement['sortOrder'];
+        });
+
+        return $menuSectionsData;
+    }
+}

app/code/Magento/PageBuilder/Model/Config/MenuSection/Converter.php

@@ -6,8 +6,11 @@
 
 declare(strict_types=1);
 
-namespace Magento\PageBuilder\Model\Config\Group;
+namespace Magento\PageBuilder\Model\Config\MenuSection;
 
+/**
+ * Reader for menu section in configuration
+ */
 class Reader extends \Magento\Framework\Config\Reader\Filesystem
 {
     /**
@@ -16,15 +19,15 @@ class Reader extends \Magento\Framework\Config\Reader\Filesystem
      * @var array
      */
     protected $_idAttributes = [
-        '/config/group' => 'name'
+        '/config/menu_section' => 'name'
     ];
 
     /**
      * Constructor
      *
      * @param \Magento\PageBuilder\Model\Config\FileResolver $fileResolver
-     * @param \Magento\PageBuilder\Model\Config\Group\Converter $converter
-     * @param \Magento\PageBuilder\Model\Config\Group\SchemaLocator $schemaLocator
+     * @param \Magento\PageBuilder\Model\Config\MenuSection\Converter $converter
+     * @param \Magento\PageBuilder\Model\Config\MenuSection\SchemaLocator $schemaLocator
      * @param \Magento\Framework\Config\ValidationStateInterface $validationState
      * @param string $fileName
      * @param array $idAttributes
@@ -33,10 +36,10 @@ class Reader extends \Magento\Framework\Config\Reader\Filesystem
      */
     public function __construct(
         \Magento\PageBuilder\Model\Config\FileResolver $fileResolver,
-        \Magento\PageBuilder\Model\Config\Group\Converter $converter,
-        \Magento\PageBuilder\Model\Config\Group\SchemaLocator $schemaLocator,
+        \Magento\PageBuilder\Model\Config\MenuSection\Converter $converter,
+        \Magento\PageBuilder\Model\Config\MenuSection\SchemaLocator $schemaLocator,
         \Magento\Framework\Config\ValidationStateInterface $validationState,
-        string $fileName = 'group.xml',
+        string $fileName = 'menu_section.xml',
         array $idAttributes = [],
         string $domDocumentClass = \Magento\Framework\Config\Dom::class,
         string $defaultScope = 'global'

app/code/Magento/PageBuilder/Model/Config/Group/Reader.php renamed to app/code/Magento/PageBuilder/Model/Config/MenuSection/Reader.php

@@ -6,8 +6,11 @@
 
 declare(strict_types=1);
 
-namespace Magento\PageBuilder\Model\Config\Group;
+namespace Magento\PageBuilder\Model\Config\MenuSection;
 
+/**
+ * Schema locator for menu section in configuration
+ */
 class SchemaLocator implements \Magento\Framework\Config\SchemaLocatorInterface
 {
     /**
@@ -31,8 +34,8 @@ public function __construct(
         \Magento\Framework\Module\Dir\Reader $moduleReader
     ) {
         $etcDir = $moduleReader->getModuleDir('etc', 'Magento_PageBuilder');
-        $this->schema = $etcDir . DIRECTORY_SEPARATOR . 'group_merged.xsd';
-        $this->perFileSchema = $etcDir . DIRECTORY_SEPARATOR . 'group.xsd';
+        $this->schema = $etcDir . DIRECTORY_SEPARATOR . 'menu_section_merged.xsd';
+        $this->perFileSchema = $etcDir . DIRECTORY_SEPARATOR . 'menu_section.xsd';
     }
 
     /**

app/code/Magento/PageBuilder/Model/Config/Group/SchemaLocator.php renamed to app/code/Magento/PageBuilder/Model/Config/MenuSection/SchemaLocator.php

@@ -15,16 +15,22 @@
 interface ConfigInterface
 {
     /**
+     * Gets all the menu sections
+     *
      * @return array
      */
-    public function getGroups() : array;
+    public function getMenuSections() : array;
 
     /**
+     * Gets all the content types
+     *
      * @return array
      */
     public function getContentTypes() : array;
 
     /**
+     * Get if PageBuilder is enabled
+     *
      * @return bool
      */
     public function isEnabled() : bool;