@wordpress/block-editor 9.3.0 → 9.6.0

package/src/utils/selection.js

@@ -0,0 +1,26 @@
+/**
+ * A robust way to retain selection position through various
+ * transforms is to insert a special character at the position and
+ * then recover it.
+ */
+export const START_OF_SELECTED_AREA = '\u0086';
+
+/**
+ * Retrieve the block attribute that contains the selection position.
+ *
+ * @param {Object} blockAttributes Block attributes.
+ * @return {string|void} The name of the block attribute that was previously selected.
+ */
+export function retrieveSelectedAttribute( blockAttributes ) {
+	if ( ! blockAttributes ) {
+		return;
+	}
+
+	return Object.keys( blockAttributes ).find( ( name ) => {
+		const value = blockAttributes[ name ];
+		return (
+			typeof value === 'string' &&
+			value.indexOf( START_OF_SELECTED_AREA ) !== -1
+		);
+	} );
+}

package/src/utils/test/selection.js

@@ -0,0 +1,39 @@
+/**
+ * Internal dependencies
+ */
+import {
+	retrieveSelectedAttribute,
+	START_OF_SELECTED_AREA,
+} from '../selection';
+
+describe( 'retrieveSelectedAttribute', () => {
+	it( 'returns undefined if block attributes are not an object', () => {
+		expect( retrieveSelectedAttribute( undefined ) ).toBeUndefined();
+		expect( retrieveSelectedAttribute( null ) ).toBeUndefined();
+	} );
+
+	it( 'returns the block attribute name if it contains the selection position character', () => {
+		const blockAttributes = {
+			foo: `this is not selected`,
+			bar: `this${ START_OF_SELECTED_AREA }is selected`,
+		};
+		expect( retrieveSelectedAttribute( blockAttributes ) ).toBe( 'bar' );
+	} );
+
+	it( 'returns the first block attribute that contains the selection position character', () => {
+		const blockAttributes = {
+			foo: `this is not selected`,
+			bar: `this${ START_OF_SELECTED_AREA }is selected`,
+			baz: `this${ START_OF_SELECTED_AREA }is selected`,
+		};
+		expect( retrieveSelectedAttribute( blockAttributes ) ).toBe( 'bar' );
+	} );
+
+	it( 'returns undefined if no block attribute contains the selection position character', () => {
+		const blockAttributes = {
+			foo: `this is not selected`,
+			bar: `this is not selected either`,
+		};
+		expect( retrieveSelectedAttribute( blockAttributes ) ).toBeUndefined();
+	} );
+} );

package/tsconfig.json

@@ -7,7 +7,8 @@
 	"references": [
 		{ "path": "../deprecated" },
 		{ "path": "../element" },
-		{ "path": "../hooks" }
+		{ "path": "../hooks" },
+		{ "path": "../data" }
 	],
 	// NOTE: This package is being progressively typed. You are encouraged to
 	// expand this array with files which can be type-checked. At some point in