/** * External dependencies */ import { BlockInstance, createBlock, getBlockType, registerBlockType, unregisterBlockType, parse, } from '@wordpress/blocks'; import type { BlockEditProps } from '@wordpress/blocks'; import { WC_BLOCKS_IMAGE_URL } from '@woocommerce/block-settings'; import { useBlockProps, BlockPreview, store as blockEditorStore, } from '@wordpress/block-editor'; import { Button, Placeholder, Popover } from '@wordpress/components'; import { __ } from '@wordpress/i18n'; import { box, Icon } from '@wordpress/icons'; import { useDispatch, subscribe, useSelect, select, dispatch, } from '@wordpress/data'; import { useEffect, useState } from '@wordpress/element'; import { store as noticesStore } from '@wordpress/notices'; import { useEntityRecord } from '@wordpress/core-data'; import { debounce } from '@woocommerce/base-utils'; import { woo } from '@woocommerce/icons'; import { isNumber } from '@woocommerce/types'; /** * Internal dependencies */ import './editor.scss'; import './style.scss'; 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 * as blockifiedOrderConfirmation from './order-confirmation'; import type { BlockifiedTemplateConfig } from './types'; type Attributes = { template: string; align: string; }; const blockifiedFallbackConfig = { isConversionPossible: () => false, getBlockifiedTemplate: () => [], getDescription: () => '', onClickCallback: () => void 0, }; const conversionConfig: { [ key: string ]: BlockifiedTemplateConfig } = { [ TYPES.productCatalog ]: blockifiedProductCatalogConfig, [ TYPES.productTaxonomy ]: blockifiedProductTaxonomyConfig, [ TYPES.singleProduct ]: blockifiedSingleProduct, [ TYPES.productSearchResults ]: blockifiedProductSearchResults, [ TYPES.orderConfirmation ]: blockifiedOrderConfirmation, fallback: blockifiedFallbackConfig, }; const pickBlockClientIds = ( blocks: Array< BlockInstance > ) => blocks.reduce< Array< string > >( ( acc, block ) => { if ( block.name === 'core/template-part' ) { return acc; } return [ ...acc, block.clientId ]; }, [] ); const ConvertTemplate = ( { blockifyConfig, clientId, attributes } ) => { const { getButtonLabel, onClickCallback, getBlockifiedTemplate } = blockifyConfig; const [ isPopoverOpen, setIsPopoverOpen ] = useState( false ); const { replaceBlock, selectBlock, replaceBlocks } = useDispatch( blockEditorStore ); const { getBlocks } = useSelect( ( sel ) => { return { getBlocks: sel( blockEditorStore ).getBlocks, }; }, [] ); const { createInfoNotice } = useDispatch( noticesStore ); return (
); }; const Edit = ( { clientId, attributes, setAttributes, }: BlockEditProps< Attributes > ) => { const blockProps = useBlockProps(); const { editedPostId } = useSelect( ( sel ) => { return { editedPostId: sel( 'core/edit-site' ).getEditedPostId(), }; }, [] ); const template = useEntityRecord< { slug: string; title: { rendered?: string; row: string; }; } >( 'postType', 'wp_template', editedPostId ); const templateDetails = getTemplateDetailsBySlug( attributes.template, TEMPLATES ); const templateTitle = template.record?.title.rendered?.toLowerCase() ?? attributes.template; const templatePlaceholder = templateDetails?.placeholder ?? 'fallback'; const templateType = templateDetails?.type ?? 'fallback'; useEffect( () => setAttributes( { template: attributes.template, align: attributes.align ?? 'wide', } ), [ attributes.align, attributes.template, setAttributes ] ); const { isConversionPossible, getDescription, getSkeleton, blockifyConfig, } = conversionConfig[ templateType ]; const skeleton = getSkeleton ? ( getSkeleton() ) : ( { ); const canConvert = isConversionPossible(); const placeholderDescription = getDescription( templateTitle, canConvert ); return (
{ skeleton }
{ ' ' } { __( 'WooCommerce', 'woocommerce' ) } { __( 'Classic Template Placeholder', 'woocommerce' ) }

{ __( 'You cannot edit the content of this block. However, you can move it and place other blocks around it.', 'woocommerce' ) }

{ canConvert && blockifyConfig && ( ) }
); }; const registerClassicTemplateBlock = ( { template, inserter, }: { template?: string; inserter: boolean; } ) => { /** * The 'WooCommerce Legacy Template' block was renamed to 'WooCommerce Classic Template', however, the internal block * name 'woocommerce/legacy-template' needs to remain the same. Otherwise, it would result in a corrupt block when * loaded for users who have customized templates using the legacy-template (since the internal block name is * stored in the database). * * See https://github.com/woocommerce/woocommerce-gutenberg-products-block/issues/5861 for more context */ registerBlockType( BLOCK_SLUG, { title: template && TEMPLATES[ template ] ? TEMPLATES[ template ].title : __( 'WooCommerce Classic Template', 'woocommerce' ), icon: ( ), category: 'woocommerce', apiVersion: 2, keywords: [ __( 'WooCommerce', 'woocommerce' ) ], description: __( 'Renders classic WooCommerce PHP templates.', 'woocommerce' ), supports: { align: [ 'wide', 'full' ], html: false, multiple: false, reusable: false, inserter, }, attributes: { /** * Template attribute is used to determine which core PHP template gets rendered. */ template: { type: 'string', default: 'any', }, align: { type: 'string', default: 'wide', }, }, edit: ( { attributes, clientId, setAttributes, }: BlockEditProps< Attributes > ) => { const newTemplate = template ?? attributes.template; return ( ); }, save: () => null, } ); }; /** * Attempts to recover the Classic Template block if it fails to render on the Single Product template * due to the user resetting customizations without refreshing the page. * * When the Classic Template block fails to render, it is replaced by the 'core/missing' block, which * displays an error message stating that the WooCommerce Classic template block is unsupported. * * This function replaces the 'core/missing' block with the original Classic Template block that failed * to render, allowing the block to be displayed correctly. * * @see {@link https://github.com/woocommerce/woocommerce-blocks/issues/9637|Issue: Block error is displayed on clearing customizations for Woo Templates} * */ const tryToRecoverClassicTemplateBlockWhenItFailsToRender = debounce( () => { const blocks = select( 'core/block-editor' ).getBlocks(); const blocksIncludingInnerBlocks = blocks.flatMap( ( block ) => [ block, ...block.innerBlocks, ] ); const classicTemplateThatFailedToRender = blocksIncludingInnerBlocks.find( ( block ) => block.name === 'core/missing' && block.attributes.originalName === BLOCK_SLUG ); if ( classicTemplateThatFailedToRender ) { const blockToReplaceClassicTemplateBlockThatFailedToRender = parse( classicTemplateThatFailedToRender.attributes.originalContent ); if ( blockToReplaceClassicTemplateBlockThatFailedToRender ) { dispatch( 'core/block-editor' ).replaceBlock( classicTemplateThatFailedToRender.clientId, blockToReplaceClassicTemplateBlockThatFailedToRender ); } } }, 100 ); // @todo Refactor when there will be possible to show a block according on a template/post with a Gutenberg API. https://github.com/WordPress/gutenberg/pull/41718 let currentTemplateId: string | undefined; subscribe( () => { const previousTemplateId = currentTemplateId; const store = select( 'core/edit-site' ); // With GB 16.3.0 the return type can be a number: https://github.com/WordPress/gutenberg/issues/53230 const editedPostId = store?.getEditedPostId() as | string | number | undefined; currentTemplateId = isNumber( editedPostId ) ? undefined : editedPostId; const parsedTemplate = currentTemplateId?.split( '//' )[ 1 ]; if ( parsedTemplate === null || parsedTemplate === undefined ) { return; } const block = getBlockType( BLOCK_SLUG ); const isBlockRegistered = Boolean( block ); if ( isBlockRegistered && hasTemplateSupportForClassicTemplateBlock( parsedTemplate, TEMPLATES ) ) { tryToRecoverClassicTemplateBlockWhenItFailsToRender(); } if ( previousTemplateId === currentTemplateId ) { return; } if ( isBlockRegistered && ( ! hasTemplateSupportForClassicTemplateBlock( parsedTemplate, TEMPLATES ) || isClassicTemplateBlockRegisteredWithAnotherTitle( block, parsedTemplate ) ) ) { unregisterBlockType( BLOCK_SLUG ); currentTemplateId = undefined; return; } if ( ! isBlockRegistered && hasTemplateSupportForClassicTemplateBlock( parsedTemplate, TEMPLATES ) ) { registerClassicTemplateBlock( { template: parsedTemplate, inserter: true, } ); } }, 'core/blocks-editor' );