@wordpress/editor 13.30.0 → 13.32.0

package/src/store/utils/get-filtered-template-parts.js

@@ -0,0 +1,69 @@
+/**
+ * External dependencies
+ */
+import memoize from 'memize';
+
+/**
+ * WordPress dependencies
+ */
+import { isTemplatePart } from '@wordpress/blocks';
+
+const EMPTY_ARRAY = [];
+
+/**
+ * Get a flattened and filtered list of template parts and the matching block for that template part.
+ *
+ * Takes a list of blocks defined within a template, and a list of template parts, and returns a
+ * flattened list of template parts and the matching block for that template part.
+ *
+ * @param {Array}  blocks        Blocks to flatten.
+ * @param {?Array} templateParts Available template parts.
+ * @return {Array} An array of template parts and their blocks.
+ */
+function getFilteredTemplatePartBlocks( blocks = EMPTY_ARRAY, templateParts ) {
+	const templatePartsById = templateParts
+		? // Key template parts by their ID.
+		  templateParts.reduce(
+				( newTemplateParts, part ) => ( {
+					...newTemplateParts,
+					[ part.id ]: part,
+				} ),
+				{}
+		  )
+		: {};
+
+	const result = [];
+
+	// Iterate over all blocks, recursing into inner blocks.
+	// Output will be based on a depth-first traversal.
+	const stack = [ ...blocks ];
+	while ( stack.length ) {
+		const { innerBlocks, ...block } = stack.shift();
+		// Place inner blocks at the beginning of the stack to preserve order.
+		stack.unshift( ...innerBlocks );
+
+		if ( isTemplatePart( block ) ) {
+			const {
+				attributes: { theme, slug },
+			} = block;
+			const templatePartId = `${ theme }//${ slug }`;
+			const templatePart = templatePartsById[ templatePartId ];
+
+			// Only add to output if the found template part block is in the list of available template parts.
+			if ( templatePart ) {
+				result.push( {
+					templatePart,
+					block,
+				} );
+			}
+		}
+	}
+
+	return result;
+}
+
+const memoizedGetFilteredTemplatePartBlocks = memoize(
+	getFilteredTemplatePartBlocks
+);
+
+export { memoizedGetFilteredTemplatePartBlocks as getFilteredTemplatePartBlocks };

package/src/store/utils/test/get-filtered-template-parts.js

@@ -0,0 +1,189 @@
+/**
+ * Internal dependencies
+ */
+import { getFilteredTemplatePartBlocks } from '../get-filtered-template-parts';
+
+const NESTED_BLOCKS = [
+	{
+		clientId: '1',
+		name: 'core/group',
+		innerBlocks: [
+			{
+				clientId: '2',
+				name: 'core/template-part',
+				attributes: {
+					slug: 'header',
+					theme: 'my-theme',
+				},
+				innerBlocks: [
+					{
+						clientId: '3',
+						name: 'core/group',
+						innerBlocks: [],
+					},
+				],
+			},
+			{
+				clientId: '4',
+				name: 'core/template-part',
+				attributes: {
+					slug: 'aside',
+					theme: 'my-theme',
+				},
+				innerBlocks: [],
+			},
+		],
+	},
+	{
+		clientId: '5',
+		name: 'core/paragraph',
+		innerBlocks: [],
+	},
+	{
+		clientId: '6',
+		name: 'core/template-part',
+		attributes: {
+			slug: 'footer',
+			theme: 'my-theme',
+		},
+		innerBlocks: [],
+	},
+];
+
+const FLATTENED_BLOCKS = [
+	{
+		block: {
+			clientId: '2',
+			name: 'core/template-part',
+			attributes: {
+				slug: 'header',
+				theme: 'my-theme',
+			},
+		},
+		templatePart: {
+			id: 'my-theme//header',
+			slug: 'header',
+			theme: 'my-theme',
+		},
+	},
+	{
+		block: {
+			clientId: '4',
+			name: 'core/template-part',
+			attributes: {
+				slug: 'aside',
+				theme: 'my-theme',
+			},
+		},
+		templatePart: {
+			id: 'my-theme//aside',
+			slug: 'aside',
+			theme: 'my-theme',
+		},
+	},
+	{
+		block: {
+			clientId: '6',
+			name: 'core/template-part',
+			attributes: {
+				slug: 'footer',
+				theme: 'my-theme',
+			},
+		},
+		templatePart: {
+			id: 'my-theme//footer',
+			slug: 'footer',
+			theme: 'my-theme',
+		},
+	},
+];
+
+const SINGLE_TEMPLATE_PART_BLOCK = {
+	clientId: '1',
+	name: 'core/template-part',
+	innerBlocks: [],
+	attributes: {
+		slug: 'aside',
+		theme: 'my-theme',
+	},
+};
+
+const TEMPLATE_PARTS = [
+	{
+		id: 'my-theme//header',
+		slug: 'header',
+		theme: 'my-theme',
+	},
+	{
+		id: 'my-theme//aside',
+		slug: 'aside',
+		theme: 'my-theme',
+	},
+	{
+		id: 'my-theme//footer',
+		slug: 'footer',
+		theme: 'my-theme',
+	},
+];
+
+describe( 'getFilteredTemplatePartBlocks', () => {
+	it( 'returns a flattened list of filtered template parts preserving a depth-first order', () => {
+		const flattenedFilteredTemplateParts = getFilteredTemplatePartBlocks(
+			NESTED_BLOCKS,
+			TEMPLATE_PARTS
+		);
+		expect( flattenedFilteredTemplateParts ).toEqual( FLATTENED_BLOCKS );
+	} );
+
+	it( 'returns a cached result when passed the same params', () => {
+		// Clear the cache and call the function twice.
+		getFilteredTemplatePartBlocks.clear();
+		getFilteredTemplatePartBlocks( NESTED_BLOCKS, TEMPLATE_PARTS );
+		expect(
+			getFilteredTemplatePartBlocks( NESTED_BLOCKS, TEMPLATE_PARTS )
+		).toEqual( FLATTENED_BLOCKS );
+
+		// The function has been called twice with the same params, so the cache size should be 1.
+		/**
+		 * TODO what should be done about this?
+		 * Can it be tested another way?
+		 * Is it necessary?
+		 */
+		// const [ , , originalSize ] =
+		// 	getFilteredTemplatePartBlocks.getCache();
+		// expect( originalSize ).toBe( 1 );
+
+		// Call the function again, with different params.
+		expect(
+			getFilteredTemplatePartBlocks(
+				[ SINGLE_TEMPLATE_PART_BLOCK ],
+				TEMPLATE_PARTS
+			)
+		).toEqual( [
+			{
+				block: {
+					clientId: '1',
+					name: 'core/template-part',
+					attributes: {
+						slug: 'aside',
+						theme: 'my-theme',
+					},
+				},
+				templatePart: {
+					id: 'my-theme//aside',
+					slug: 'aside',
+					theme: 'my-theme',
+				},
+			},
+		] );
+
+		// The function has been called with different params, so the cache size should now be 2.
+		/**
+		 * TODO what should be done about this?
+		 * Can it be tested another way?
+		 * Is it necessary?
+		 */
+		// const [ , , finalSize ] = getFilteredTemplatePartBlocks.getCache();
+		// expect( finalSize ).toBe( 2 );
+	} );
+} );

package/src/style.scss

@@ -9,6 +9,7 @@
 @import "./components/inserter-sidebar/style.scss";
 @import "./components/list-view-sidebar/style.scss";
 @import "./components/post-author/style.scss";
+@import "./components/post-card-panel/style.scss";
 @import "./components/post-excerpt/style.scss";
 @import "./components/post-featured-image/style.scss";
 @import "./components/post-format/style.scss";
@@ -29,4 +30,5 @@
 @import "./components/post-trash/style.scss";
 @import "./components/preview-dropdown/style.scss";
 @import "./components/table-of-contents/style.scss";
+@import "./components/template-areas/style.scss";
 @import "./components/template-validation-notice/style.scss";