@wordpress/block-editor 12.1.0 → 12.3.0

package/src/components/off-canvas-editor/test/use-inserted-block.js

@@ -1,108 +0,0 @@
-/**
- * Internal dependencies
- */
-import { useInsertedBlock } from '../use-inserted-block';
-
-/**
- * WordPress dependencies
- */
-import { useDispatch, useSelect } from '@wordpress/data';
-
-/**
- * External dependencies
- */
-import { act, renderHook } from '@testing-library/react';
-
-jest.mock( '@wordpress/data/src/components/use-select', () => {
-	// This allows us to tweak the returned value on each test.
-	const mock = jest.fn();
-	return mock;
-} );
-
-jest.mock( '@wordpress/data/src/components/use-dispatch', () => ( {
-	useDispatch: jest.fn(),
-} ) );
-
-describe( 'useInsertedBlock', () => {
-	const mockUpdateBlockAttributes = jest.fn();
-
-	it( 'returns undefined values when called without a block clientId', () => {
-		useSelect.mockImplementation( () => ( {
-			insertedBlockAttributes: {
-				'some-attribute': 'some-value',
-			},
-			insertedBlockName: 'core/navigation-link',
-		} ) );
-
-		useDispatch.mockImplementation( () => ( {
-			updateBlockAttributes: mockUpdateBlockAttributes,
-		} ) );
-
-		const { result } = renderHook( () => useInsertedBlock() );
-
-		const {
-			insertedBlockName,
-			insertedBlockAttributes,
-			setInsertedBlockAttributes,
-		} = result.current;
-
-		expect( insertedBlockName ).toBeUndefined();
-		expect( insertedBlockAttributes ).toBeUndefined();
-		expect(
-			setInsertedBlockAttributes( { 'some-attribute': 'new-value' } )
-		).toBeUndefined();
-	} );
-
-	it( 'returns name and attributes when called with a block clientId', () => {
-		useSelect.mockImplementation( () => ( {
-			insertedBlockAttributes: {
-				'some-attribute': 'some-value',
-			},
-			insertedBlockName: 'core/navigation-link',
-		} ) );
-
-		useDispatch.mockImplementation( () => ( {
-			updateBlockAttributes: mockUpdateBlockAttributes,
-		} ) );
-
-		const { result } = renderHook( () =>
-			useInsertedBlock( 'some-client-id-here' )
-		);
-
-		const { insertedBlockName, insertedBlockAttributes } = result.current;
-
-		expect( insertedBlockName ).toBe( 'core/navigation-link' );
-		expect( insertedBlockAttributes ).toEqual( {
-			'some-attribute': 'some-value',
-		} );
-	} );
-
-	it( 'dispatches updateBlockAttributes on provided client ID with new attributes when setInsertedBlockAttributes is called', () => {
-		useSelect.mockImplementation( () => ( {
-			insertedBlockAttributes: {
-				'some-attribute': 'some-value',
-			},
-			insertedBlockName: 'core/navigation-link',
-		} ) );
-
-		useDispatch.mockImplementation( () => ( {
-			updateBlockAttributes: mockUpdateBlockAttributes,
-		} ) );
-
-		const clientId = '123456789';
-
-		const { result } = renderHook( () => useInsertedBlock( clientId ) );
-
-		const { setInsertedBlockAttributes } = result.current;
-
-		act( () => {
-			setInsertedBlockAttributes( {
-				'some-attribute': 'new-value',
-			} );
-		} );
-
-		expect( mockUpdateBlockAttributes ).toHaveBeenCalledWith( clientId, {
-			'some-attribute': 'new-value',
-		} );
-	} );
-} );

package/src/components/off-canvas-editor/test/utils.js

@@ -1,50 +0,0 @@
-/**
- * Internal dependencies
- */
-import { getCommonDepthClientIds } from '../utils';
-
-describe( 'getCommonDepthClientIds', () => {
-	it( 'should return start and end when no depth is provided', () => {
-		const result = getCommonDepthClientIds(
-			'start-id',
-			'clicked-id',
-			[],
-			[]
-		);
-
-		expect( result ).toEqual( { start: 'start-id', end: 'clicked-id' } );
-	} );
-
-	it( 'should return deepest start and end when depths match', () => {
-		const result = getCommonDepthClientIds(
-			'start-id',
-			'clicked-id',
-			[ 'start-1', 'start-2', 'start-3' ],
-			[ 'end-1', 'end-2', 'end-3' ]
-		);
-
-		expect( result ).toEqual( { start: 'start-id', end: 'clicked-id' } );
-	} );
-
-	it( 'should return shallower ids when start is shallower', () => {
-		const result = getCommonDepthClientIds(
-			'start-id',
-			'clicked-id',
-			[ 'start-1' ],
-			[ 'end-1', 'end-2', 'end-3' ]
-		);
-
-		expect( result ).toEqual( { start: 'start-id', end: 'end-2' } );
-	} );
-
-	it( 'should return shallower ids when end is shallower', () => {
-		const result = getCommonDepthClientIds(
-			'start-id',
-			'clicked-id',
-			[ 'start-1', 'start-2', 'start-3' ],
-			[ 'end-1', 'end-2' ]
-		);
-
-		expect( result ).toEqual( { start: 'start-3', end: 'clicked-id' } );
-	} );
-} );

package/src/components/off-canvas-editor/update-attributes.js

@@ -1,99 +0,0 @@
-/**
- * WordPress dependencies
- */
-import { escapeHTML } from '@wordpress/escape-html';
-import { safeDecodeURI } from '@wordpress/url';
-
-/**
- * @typedef {'post-type'|'custom'|'taxonomy'|'post-type-archive'} WPNavigationLinkKind
- */
-/**
- * Navigation Link Block Attributes
- *
- * @typedef {Object} WPNavigationLinkBlockAttributes
- *
- * @property {string}               [label]         Link text.
- * @property {WPNavigationLinkKind} [kind]          Kind is used to differentiate between term and post ids to check post draft status.
- * @property {string}               [type]          The type such as post, page, tag, category and other custom types.
- * @property {string}               [rel]           The relationship of the linked URL.
- * @property {number}               [id]            A post or term id.
- * @property {boolean}              [opensInNewTab] Sets link target to _blank when true.
- * @property {string}               [url]           Link href.
- * @property {string}               [title]         Link title attribute.
- */
-/**
- * Link Control onChange handler that updates block attributes when a setting is changed.
- *
- * @param {Object}                          updatedValue    New block attributes to update.
- * @param {Function}                        setAttributes   Block attribute update function.
- * @param {WPNavigationLinkBlockAttributes} blockAttributes Current block attributes.
- *
- */
-
-export const updateAttributes = (
-	updatedValue = {},
-	setAttributes,
-	blockAttributes = {}
-) => {
-	const {
-		label: originalLabel = '',
-		kind: originalKind = '',
-		type: originalType = '',
-	} = blockAttributes;
-
-	const {
-		title: newLabel = '', // the title of any provided Post.
-		url: newUrl = '',
-		opensInNewTab,
-		id,
-		kind: newKind = originalKind,
-		type: newType = originalType,
-	} = updatedValue;
-
-	const newLabelWithoutHttp = newLabel.replace( /http(s?):\/\//gi, '' );
-	const newUrlWithoutHttp = newUrl.replace( /http(s?):\/\//gi, '' );
-
-	const useNewLabel =
-		newLabel &&
-		newLabel !== originalLabel &&
-		// LinkControl without the title field relies
-		// on the check below. Specifically, it assumes that
-		// the URL is the same as a title.
-		// This logic a) looks suspicious and b) should really
-		// live in the LinkControl and not here. It's a great
-		// candidate for future refactoring.
-		newLabelWithoutHttp !== newUrlWithoutHttp;
-
-	// Unfortunately this causes the escaping model to be inverted.
-	// The escaped content is stored in the block attributes (and ultimately in the database),
-	// and then the raw data is "recovered" when outputting into the DOM.
-	// It would be preferable to store the **raw** data in the block attributes and escape it in JS.
-	// Why? Because there isn't one way to escape data. Depending on the context, you need to do
-	// different transforms. It doesn't make sense to me to choose one of them for the purposes of storage.
-	// See also:
-	// - https://github.com/WordPress/gutenberg/pull/41063
-	// - https://github.com/WordPress/gutenberg/pull/18617.
-	const label = useNewLabel
-		? escapeHTML( newLabel )
-		: originalLabel || escapeHTML( newUrlWithoutHttp );
-
-	// In https://github.com/WordPress/gutenberg/pull/24670 we decided to use "tag" in favor of "post_tag"
-	const type = newType === 'post_tag' ? 'tag' : newType.replace( '-', '_' );
-
-	const isBuiltInType =
-		[ 'post', 'page', 'tag', 'category' ].indexOf( type ) > -1;
-
-	const isCustomLink =
-		( ! newKind && ! isBuiltInType ) || newKind === 'custom';
-	const kind = isCustomLink ? 'custom' : newKind;
-
-	setAttributes( {
-		// Passed `url` may already be encoded. To prevent double encoding, decodeURI is executed to revert to the original string.
-		...( newUrl && { url: encodeURI( safeDecodeURI( newUrl ) ) } ),
-		...( label && { label } ),
-		...( undefined !== opensInNewTab && { opensInNewTab } ),
-		...( id && Number.isInteger( id ) && { id } ),
-		...( kind && { kind } ),
-		...( type && type !== 'URL' && { type } ),
-	} );
-};

package/src/components/off-canvas-editor/use-block-selection.js

@@ -1,169 +0,0 @@
-/**
- * WordPress dependencies
- */
-import { speak } from '@wordpress/a11y';
-import { __, sprintf } from '@wordpress/i18n';
-import { useDispatch, useSelect } from '@wordpress/data';
-import { useCallback } from '@wordpress/element';
-import { UP, DOWN, HOME, END } from '@wordpress/keycodes';
-import { store as blocksStore } from '@wordpress/blocks';
-
-/**
- * Internal dependencies
- */
-import { store as blockEditorStore } from '../../store';
-import { getCommonDepthClientIds } from './utils';
-
-export default function useBlockSelection() {
-	const { clearSelectedBlock, multiSelect, selectBlock } =
-		useDispatch( blockEditorStore );
-	const {
-		getBlockName,
-		getBlockParents,
-		getBlockSelectionStart,
-		getBlockSelectionEnd,
-		getSelectedBlockClientIds,
-		hasMultiSelection,
-		hasSelectedBlock,
-	} = useSelect( blockEditorStore );
-
-	const { getBlockType } = useSelect( blocksStore );
-
-	const updateBlockSelection = useCallback(
-		async ( event, clientId, destinationClientId ) => {
-			if ( ! event?.shiftKey ) {
-				selectBlock( clientId );
-				return;
-			}
-
-			// To handle multiple block selection via the `SHIFT` key, prevent
-			// the browser default behavior of opening the link in a new window.
-			event.preventDefault();
-
-			const isKeyPress =
-				event.type === 'keydown' &&
-				( event.keyCode === UP ||
-					event.keyCode === DOWN ||
-					event.keyCode === HOME ||
-					event.keyCode === END );
-
-			// Handle clicking on a block when no blocks are selected, and return early.
-			if (
-				! isKeyPress &&
-				! hasSelectedBlock() &&
-				! hasMultiSelection()
-			) {
-				selectBlock( clientId, null );
-				return;
-			}
-
-			const selectedBlocks = getSelectedBlockClientIds();
-			const clientIdWithParents = [
-				...getBlockParents( clientId ),
-				clientId,
-			];
-
-			if (
-				isKeyPress &&
-				! selectedBlocks.some( ( blockId ) =>
-					clientIdWithParents.includes( blockId )
-				)
-			) {
-				// Ensure that shift-selecting blocks via the keyboard only
-				// expands the current selection if focusing over already
-				// selected blocks. Otherwise, clear the selection so that
-				// a user can create a new selection entirely by keyboard.
-				await clearSelectedBlock();
-			}
-
-			let startTarget = getBlockSelectionStart();
-			let endTarget = clientId;
-
-			// Handle keyboard behavior for selecting multiple blocks.
-			if ( isKeyPress ) {
-				if ( ! hasSelectedBlock() && ! hasMultiSelection() ) {
-					// Set the starting point of the selection to the currently
-					// focused block, if there are no blocks currently selected.
-					// This ensures that as the selection is expanded or contracted,
-					// the starting point of the selection is anchored to that block.
-					startTarget = clientId;
-				}
-				if ( destinationClientId ) {
-					// If the user presses UP or DOWN, we want to ensure that the block they're
-					// moving to is the target for selection, and not the currently focused one.
-					endTarget = destinationClientId;
-				}
-			}
-
-			const startParents = getBlockParents( startTarget );
-			const endParents = getBlockParents( endTarget );
-
-			const { start, end } = getCommonDepthClientIds(
-				startTarget,
-				endTarget,
-				startParents,
-				endParents
-			);
-			await multiSelect( start, end, null );
-
-			// Announce deselected block, or number of deselected blocks if
-			// the total number of blocks deselected is greater than one.
-			const updatedSelectedBlocks = getSelectedBlockClientIds();
-
-			// If the selection is greater than 1 and the Home or End keys
-			// were used to generate the selection, then skip announcing the
-			// deselected blocks.
-			if (
-				( event.keyCode === HOME || event.keyCode === END ) &&
-				updatedSelectedBlocks.length > 1
-			) {
-				return;
-			}
-
-			const selectionDiff = selectedBlocks.filter(
-				( blockId ) => ! updatedSelectedBlocks.includes( blockId )
-			);
-
-			let label;
-			if ( selectionDiff.length === 1 ) {
-				const title = getBlockType(
-					getBlockName( selectionDiff[ 0 ] )
-				)?.title;
-				if ( title ) {
-					label = sprintf(
-						/* translators: %s: block name */
-						__( '%s deselected.' ),
-						title
-					);
-				}
-			} else if ( selectionDiff.length > 1 ) {
-				label = sprintf(
-					/* translators: %s: number of deselected blocks */
-					__( '%s blocks deselected.' ),
-					selectionDiff.length
-				);
-			}
-
-			if ( label ) {
-				speak( label );
-			}
-		},
-		[
-			clearSelectedBlock,
-			getBlockName,
-			getBlockType,
-			getBlockParents,
-			getBlockSelectionStart,
-			getBlockSelectionEnd,
-			getSelectedBlockClientIds,
-			hasMultiSelection,
-			hasSelectedBlock,
-			multiSelect,
-			selectBlock,
-		]
-	);
-
-	return {
-		updateBlockSelection,
-	};
-}

package/src/components/off-canvas-editor/use-inserted-block.js

@@ -1,47 +0,0 @@
-/**
- * WordPress dependencies
- */
-import { useSelect, useDispatch } from '@wordpress/data';
-
-/**
- * Internal dependencies
- */
-import { store as blockEditorStore } from '../../store';
-
-export const useInsertedBlock = ( insertedBlockClientId ) => {
-	const { insertedBlockAttributes, insertedBlockName } = useSelect(
-		( select ) => {
-			const { getBlockName, getBlockAttributes } =
-				select( blockEditorStore );
-
-			return {
-				insertedBlockAttributes: getBlockAttributes(
-					insertedBlockClientId
-				),
-				insertedBlockName: getBlockName( insertedBlockClientId ),
-			};
-		},
-		[ insertedBlockClientId ]
-	);
-
-	const { updateBlockAttributes } = useDispatch( blockEditorStore );
-
-	const setInsertedBlockAttributes = ( _updatedAttributes ) => {
-		if ( ! insertedBlockClientId ) return;
-		updateBlockAttributes( insertedBlockClientId, _updatedAttributes );
-	};
-
-	if ( ! insertedBlockClientId ) {
-		return {
-			insertedBlockAttributes: undefined,
-			insertedBlockName: undefined,
-			setInsertedBlockAttributes,
-		};
-	}
-
-	return {
-		insertedBlockAttributes,
-		insertedBlockName,
-		setInsertedBlockAttributes,
-	};
-};

package/src/components/off-canvas-editor/use-list-view-client-ids.js

@@ -1,29 +0,0 @@
-/**
- * WordPress dependencies
- */
-
-import { useSelect } from '@wordpress/data';
-
-/**
- * Internal dependencies
- */
-import { store as blockEditorStore } from '../../store';
-
-export default function useListViewClientIds( blocks ) {
-	return useSelect(
-		( select ) => {
-			const {
-				getDraggedBlockClientIds,
-				getSelectedBlockClientIds,
-				__unstableGetClientIdsTree,
-			} = select( blockEditorStore );
-
-			return {
-				selectedClientIds: getSelectedBlockClientIds(),
-				draggedClientIds: getDraggedBlockClientIds(),
-				clientIdsTree: blocks ? blocks : __unstableGetClientIdsTree(),
-			};
-		},
-		[ blocks ]
-	);
-}