[Blockifying Product Archive Templates]: Implement the blockified tem…

…plate conversion for the Classic Template Block. (#8248)

* Extract a blockified Product Archive Template to the templates

* Add templates to tsconfig.json so the files are resolved as part of the core code

* Add a encouragement note to use blockified version IF migration is available

* Add a Row block wrapping Product Results Count and Catalog Sorting blocks

* Move blockified product-archive from templates/ to assets/ directory

* Remove unnecessary margin from Product Results Count block

When used in a Row block in a blockified Archive Product template, Product Results Count had additional unnecessary margin which caused misalignment with the Catalog Sorting block

* Update the description of the Classic Template Editor placeholder

* Remove unnecessary entry in tsconfig.json to include templates directory

It was added couple of commits earlier, since the template was kept there, but it was decided to move it to assets directory, so entry is no longer necessary

* Differentiate the Classic Template placeholder description depending on the availability to convert to Products block

* Set margin for Catalog Sorting to 0, so it aligns properly when used in blockified Archive Product template

* Make the blockification config, so it covers the Product Archive as well as Single Product templates

* Move the product-archive specific functions from classic-template/index.tsx to the product-archive.ts

* Add alignment option to the Store Notices block and make the blockified template blocks aligned wide

That is required, so the Classic Template layout is preserved

* Create single-product.ts file which is a placeholder for the blockified Single Product template

* Make Blockified Product Archive template inherit the align attibute

* Simplify the interface of blockified templates

Expose  function instead of two functions for allowing and disallowing conversion

* Add a BlockifiedTemplate type

* Rename and simplify the function checking if conversion of classic template to block version is possible

* Align the variable naming to use  instead of

* Pass the Classic Template attributes to the blockified template instead of getting it from data store

* Include Breadcrumbs block in the Blockified Product Archive Template

* Consume alignment attributes of Catalog Sorting in the PHP render function

* Consume alignment attributes of Breadcrumbs in the PHP render function

* Remove align support from Catalog Sorting and add to Store Notices block

* Extend the get_classes_and_styles_by_attributes method with align and text_align attributes

* Add Archive Title block to the Blockified Classic Template

* Minor getRowBlock function refactor

* Add  property to the classic templates and base the config on it instead of placeholder

* Add separate blockified template for a Product Search Results

* Pass  attribute from classic template to No Results block in Product Search Results

* Extract the common functions between blockified archive-template and product-search-results to utils

* Enable 'Inherit query from template' in Products block by default when converting the Classic Template to blockified one

* Improve the naming of BlockifiedTemplateConfig type

* Differentiate Product Catalog and Products By * templates. The latter include Term Description block

* Change unclear ProductsBy to ProductTaxonomy in regards to classic template conversion

* Revert the margin fix which was added already on trunk

* Move the surrounding blocks as inner blocks of Products

* Hide the conversion behind the experimental build flag (as it was before)

assets/js/blocks/classic-template/archive-product.ts

@@ -0,0 +1,123 @@
+/**
+ * External dependencies
+ */
+import {
+	createBlock,
+	createBlocksFromInnerBlocksTemplate,
+	type BlockInstance,
+} from '@wordpress/blocks';
+import { isWpVersion } from '@woocommerce/settings';
+import { __, sprintf } from '@wordpress/i18n';
+
+/**
+ * Internal dependencies
+ */
+import {
+	INNER_BLOCKS_TEMPLATE as productsInnerBlocksTemplate,
+	QUERY_DEFAULT_ATTRIBUTES as productsQueryDefaultAttributes,
+} from '../product-query/constants';
+import { VARIATION_NAME as productsVariationName } from '../product-query/variations/product-query';
+import { createArchiveTitleBlock, createRowBlock } from './utils';
+import { type InheritedAttributes } from './types';
+
+const createProductsBlock = (
+	inheritedAttributes: InheritedAttributes,
+	templateInnerBlocks: BlockInstance[]
+) => {
+	const innerBlocks = [
+		...templateInnerBlocks,
+		...createBlocksFromInnerBlocksTemplate( productsInnerBlocksTemplate ),
+	];
+
+	return createBlock(
+		'core/query',
+		{
+			...productsQueryDefaultAttributes,
+			...inheritedAttributes,
+			namespace: productsVariationName,
+			query: {
+				...productsQueryDefaultAttributes.query,
+				inherit: true,
+			},
+		},
+		innerBlocks
+	);
+};
+
+const getBlockifiedTemplate = (
+	inheritedAttributes: InheritedAttributes,
+	withTermDescription = false
+) => {
+	const templateInnerBlocks = [
+		createBlock( 'woocommerce/breadcrumbs', inheritedAttributes ),
+		createArchiveTitleBlock( 'archive-title', inheritedAttributes ),
+		withTermDescription
+			? createBlock( 'core/term-description', inheritedAttributes )
+			: null,
+		createBlock( 'woocommerce/store-notices', inheritedAttributes ),
+		createRowBlock(
+			[
+				createBlock( 'woocommerce/product-results-count' ),
+				createBlock( 'woocommerce/catalog-sorting' ),
+			],
+			inheritedAttributes
+		),
+	].filter( Boolean ) as BlockInstance[];
+
+	return createProductsBlock( inheritedAttributes, templateInnerBlocks );
+};
+
+const getBlockifiedTemplateWithTermDescription = (
+	inheritedAttributes: InheritedAttributes
+) => getBlockifiedTemplate( inheritedAttributes, true );
+
+const isConversionPossible = () => {
+	// Blockification is possible for the WP version 6.1 and above,
+	// which are the versions the Products block supports.
+	return isWpVersion( '6.1', '>=' );
+};
+
+const getDescriptionAllowingConversion = ( templateTitle: string ) =>
+	sprintf(
+		/* translators: %s is the template title */
+		__(
+			"This block serves as a placeholder for your %s. We recommend upgrading to the Products block for more features to edit your products visually. Don't worry, you can always revert back.",
+			'woo-gutenberg-products-block'
+		),
+		templateTitle
+	);
+
+const getDescriptionDisallowingConversion = ( templateTitle: string ) =>
+	sprintf(
+		/* translators: %s is the template title */
+		__(
+			'This block serves as a placeholder for your %s. It will display the actual product image, title, price in your store. You can move this placeholder around and add more blocks around to customize the template.',
+			'woo-gutenberg-products-block'
+		),
+		templateTitle
+	);
+
+const getDescription = ( templateTitle: string, canConvert: boolean ) => {
+	if ( canConvert ) {
+		return getDescriptionAllowingConversion( templateTitle );
+	}
+
+	return getDescriptionDisallowingConversion( templateTitle );
+};
+
+const getButtonLabel = () =>
+	__( 'Upgrade to Products block', 'woo-gutenberg-products-block' );
+
+export const blockifiedProductCatalogConfig = {
+	getBlockifiedTemplate,
+	isConversionPossible,
+	getDescription,
+	getButtonLabel,
+};
+
+export const blockifiedProductTaxonomyConfig = {
+	getBlockifiedTemplate: getBlockifiedTemplateWithTermDescription,
+	isConversionPossible,
+	getDescription,
+	getButtonLabel,
+};

assets/js/blocks/classic-template/constants.ts

@@ -2,54 +2,71 @@
  * External dependencies
  */
 import { __ } from '@wordpress/i18n';
-export const BLOCK_SLUG = 'woocommerce/legacy-template';
 
 /**
  * Internal dependencies
  */
 import { TemplateDetails } from './types';
 
+export const BLOCK_SLUG = 'woocommerce/legacy-template';
+export const TYPES = {
+	singleProduct: 'single-product',
+	productCatalog: 'product-catalog',
+	productTaxonomy: 'product-taxonomy',
+	productSearchResults: 'product-search-results',
+};
+export const PLACEHOLDERS = {
+	singleProduct: 'single-product',
+	archiveProduct: 'archive-product',
+};
+
 export const TEMPLATES: TemplateDetails = {
 	'single-product': {
+		type: TYPES.singleProduct,
 		title: __(
 			'WooCommerce Single Product Block',
 			'woo-gutenberg-products-block'
 		),
-		placeholder: 'single-product',
+		placeholder: PLACEHOLDERS.singleProduct,
 	},
 	'archive-product': {
+		type: TYPES.productCatalog,
 		title: __(
 			'WooCommerce Product Grid Block',
 			'woo-gutenberg-products-block'
 		),
-		placeholder: 'archive-product',
+		placeholder: PLACEHOLDERS.archiveProduct,
 	},
 	'taxonomy-product_cat': {
+		type: TYPES.productTaxonomy,
 		title: __(
 			'WooCommerce Product Taxonomy Block',
 			'woo-gutenberg-products-block'
 		),
-		placeholder: 'archive-product',
+		placeholder: PLACEHOLDERS.archiveProduct,
 	},
 	'taxonomy-product_tag': {
+		type: TYPES.productTaxonomy,
 		title: __(
 			'WooCommerce Product Tag Block',
 			'woo-gutenberg-products-block'
 		),
-		placeholder: 'archive-product',
+		placeholder: PLACEHOLDERS.archiveProduct,
 	},
 	'taxonomy-product_attribute': {
+		type: TYPES.productTaxonomy,
 		title: __(
 			'WooCommerce Product Attribute Block',
 			'woo-gutenberg-products-block'
 		),
-		placeholder: 'archive-product',
+		placeholder: PLACEHOLDERS.archiveProduct,
 	},
 	'product-search-results': {
+		type: TYPES.productSearchResults,
 		title: __(
 			'WooCommerce Product Search Results Block',
 			'woo-gutenberg-products-block'
 		),
-		placeholder: 'archive-product',
+		placeholder: PLACEHOLDERS.archiveProduct,
 	},
 };

assets/js/blocks/classic-template/index.tsx

@@ -2,7 +2,6 @@
  * External dependencies
  */
 import {
-	createBlock,
 	getBlockType,
 	registerBlockType,
 	unregisterBlockType,
@@ -14,7 +13,7 @@ import {
 } from '@woocommerce/block-settings';
 import { useBlockProps } from '@wordpress/block-editor';
 import { Button, Placeholder } from '@wordpress/components';
-import { __, sprintf } from '@wordpress/i18n';
+import { __ } from '@wordpress/i18n';
 import { box, Icon } from '@wordpress/icons';
 import { select, useDispatch, subscribe } from '@wordpress/data';
 import { useEffect } from '@wordpress/element';
@@ -24,18 +23,40 @@ import { useEffect } from '@wordpress/element';
  */
 import './editor.scss';
 import './style.scss';
-import { BLOCK_SLUG, TEMPLATES } from './constants';
+import { BLOCK_SLUG, TEMPLATES, TYPES } from './constants';
 import {
 	isClassicTemplateBlockRegisteredWithAnotherTitle,
 	hasTemplateSupportForClassicTemplateBlock,
 	getTemplateDetailsBySlug,
 } from './utils';
+import {
+	blockifiedProductCatalogConfig,
+	blockifiedProductTaxonomyConfig,
+} from './archive-product';
+import * as blockifiedSingleProduct from './single-product';
+import * as blockifiedProductSearchResults from './product-search-results';
+import type { BlockifiedTemplateConfig } from './types';
 
 type Attributes = {
 	template: string;
 	align: string;
 };
 
+const blockifiedFallbackConfig = {
+	isConversionPossible: () => false,
+	getBlockifiedTemplate: () => [],
+	getDescription: () => '',
+	getButtonLabel: () => '',
+};
+
+const conversionConfig: { [ key: string ]: BlockifiedTemplateConfig } = {
+	[ TYPES.productCatalog ]: blockifiedProductCatalogConfig,
+	[ TYPES.productTaxonomy ]: blockifiedProductTaxonomyConfig,
+	[ TYPES.singleProduct ]: blockifiedSingleProduct,
+	[ TYPES.productSearchResults ]: blockifiedProductSearchResults,
+	fallback: blockifiedFallbackConfig,
+};
+
 const Edit = ( {
 	clientId,
 	attributes,
@@ -50,6 +71,7 @@ const Edit = ( {
 	);
 	const templateTitle = templateDetails?.title ?? attributes.template;
 	const templatePlaceholder = templateDetails?.placeholder ?? 'fallback';
+	const templateType = templateDetails?.type ?? 'fallback';
 
 	useEffect(
 		() =>
@@ -60,6 +82,16 @@ const Edit = ( {
 		[ attributes.align, attributes.template, setAttributes ]
 	);
 
+	const {
+		getBlockifiedTemplate,
+		isConversionPossible,
+		getDescription,
+		getButtonLabel,
+	} = conversionConfig[ templateType ];
+
+	const canConvert = isExperimentalBuild() && isConversionPossible();
+	const placeholderDescription = getDescription( templateTitle, canConvert );
+
 	return (
 		<div { ...blockProps }>
 			<Placeholder
@@ -68,48 +100,20 @@ const Edit = ( {
 				className="wp-block-woocommerce-classic-template__placeholder"
 			>
 				<div className="wp-block-woocommerce-classic-template__placeholder-copy">
-					<p className="wp-block-woocommerce-classic-template__placeholder-warning">
-						<strong>
-							{ __(
-								'Do not remove this block!',
-								'woo-gutenberg-products-block'
-							) }
-						</strong>{ ' ' }
-						{ __(
-							'Removing this will cause unintended effects on your store.',
-							'woo-gutenberg-products-block'
-						) }
-					</p>
-					<p>
-						{ sprintf(
-							/* translators: %s is the template title */
-							__(
-								'This is a placeholder for the %s. In your store it will display the actual product image, title, price, etc. You can move this placeholder around and add more blocks around it to customize the template.',
-								'woo-gutenberg-products-block'
-							),
-							templateTitle
-						) }
-					</p>
+					<p>{ placeholderDescription }</p>
 				</div>
 				<div className="wp-block-woocommerce-classic-template__placeholder-wireframe">
-					{ isExperimentalBuild() && (
+					{ canConvert && (
 						<div className="wp-block-woocommerce-classic-template__placeholder-migration-button-container">
 							<Button
 								isPrimary
 								onClick={ () => {
 									replaceBlock(
 										clientId,
-										// TODO: Replace with the blockified version of the Product Grid Block when it will be available.
-										createBlock( 'core/paragraph', {
-											content:
-												'Instead of this block, the new Product Grid Block will be rendered',
-										} )
+										getBlockifiedTemplate( attributes )
 									);
 								} }
-								text={ __(
-									'Use the blockified Product Grid Block',
-									'woo-gutenberg-products-block'
-								) }
+								text={ getButtonLabel() }
 							/>
 						</div>
 					) }