packages/blocks/src/store/utils.ts - trunk - githubmirror/gutenberg

packages/blocks/src/store/utils.ts

59 строк2 KB

Manzoor Wani

blocks: Convert blocks package to TypeScript (#76312)

14 апр 2026, 11:18

14 апр 2026, 11:18b8ea87d

/**
 * Helper util to return a value from a certain path of the object.
 * Path is specified as either:
 * - a string of properties, separated by dots, for example: "x.y".
 * - an array of properties, for example `[ 'x', 'y' ]`.
 * You can also specify a default value in case the result is nullish.
 *
 * @param object       Input object.
 * @param path         Path to the object property.
 * @param defaultValue Default value if the value at the specified path is nullish.
 * @return Value of the object property at the specified path.
 */
export const getValueFromObjectPath = (
	object: Record< string, unknown >,
	path: string | string[],
	defaultValue?: unknown
): unknown => {
	const normalizedPath = Array.isArray( path ) ? path : path.split( '.' );
	let value: unknown = object;
	normalizedPath.forEach( ( fieldName ) => {
		value = ( value as Record< string, unknown > )?.[ fieldName ];
	} );
	return value ?? defaultValue;
};

function isObject(
	candidate: unknown
): candidate is Record< string, unknown > {
	return (
		typeof candidate === 'object' &&
		candidate !== null &&
		candidate.constructor === Object
	);
}

/**
 * Determine whether a set of object properties matches a given object.
 *
 * Given an object of block attributes and an object of variation attributes,
 * this function checks recursively whether all the variation attributes are
 * present in the block attributes object.
 *
 * @param blockAttributes     The object to inspect.
 * @param variationAttributes The object of property values to match.
 * @return Whether the block attributes match the variation attributes.
 */
export function matchesAttributes(
	blockAttributes: unknown,
	variationAttributes: unknown
): boolean {
	if ( isObject( blockAttributes ) && isObject( variationAttributes ) ) {
		return Object.entries( variationAttributes ).every(
			( [ key, value ] ) =>
				matchesAttributes( blockAttributes?.[ key ], value )
		);
	}

	return blockAttributes === variationAttributes;
}