From 7b4af68f96a6f05fe46d5aeb4ee10c2391714a46 Mon Sep 17 00:00:00 2001
From: arthur791004 <arthur.chu@automattic.com>
Date: Fri, 27 Dec 2024 13:33:33 +0800
Subject: [PATCH] Style Variations: Filter out the colors and fonts (#97795)

* Style Variations: Filter out the colors and fonts

* Fix types
---
 .../global-styles-variations/index.tsx        |  7 ++-
 .../src/gutenberg-bridge/index.tsx            | 58 +++++++++++++++++++
 2 files changed, 64 insertions(+), 1 deletion(-)

diff --git a/packages/global-styles/src/components/global-styles-variations/index.tsx b/packages/global-styles/src/components/global-styles-variations/index.tsx
index 8922cf77edde5d..c571d54dc3cfb5 100644
--- a/packages/global-styles/src/components/global-styles-variations/index.tsx
+++ b/packages/global-styles/src/components/global-styles-variations/index.tsx
@@ -12,6 +12,8 @@ import {
 	GlobalStylesContext,
 	mergeBaseAndUserConfigs,
 	withExperimentalBlockEditorProvider,
+	isColorVariation,
+	isFontVariation,
 } from '../../gutenberg-bridge';
 import { useRegisterCoreBlocks } from '../../hooks';
 import GlobalStylesVariationPreview from './preview';
@@ -127,7 +129,10 @@ const GlobalStylesVariations = ( {
 	const globalStylesVariationsWithoutDefault = useMemo(
 		() =>
 			globalStylesVariations.filter(
-				( globalStylesVariation ) => ! isDefaultGlobalStyleVariationSlug( globalStylesVariation )
+				( globalStylesVariation ) =>
+					! isDefaultGlobalStyleVariationSlug( globalStylesVariation ) &&
+					! isColorVariation( globalStylesVariation ) &&
+					! isFontVariation( globalStylesVariation )
 			),
 		[ globalStylesVariations ]
 	);
diff --git a/packages/global-styles/src/gutenberg-bridge/index.tsx b/packages/global-styles/src/gutenberg-bridge/index.tsx
index 8106e525b8f6c4..59e748e6f65174 100644
--- a/packages/global-styles/src/gutenberg-bridge/index.tsx
+++ b/packages/global-styles/src/gutenberg-bridge/index.tsx
@@ -20,6 +20,7 @@ const {
 	cleanEmptyObject,
 	ExperimentalBlockEditorProvider,
 	GlobalStylesContext: UntypedGSContext,
+	areGlobalStyleConfigsEqual,
 	useGlobalStylesOutput,
 	useGlobalSetting,
 	useGlobalStyle,
@@ -64,10 +65,67 @@ const useSafeGlobalStylesOutput = () => {
 	}
 };
 
+/**
+ * Returns a new object, with properties specified in `properties` array.,
+ * maintain the original object tree structure.
+ * The function is recursive, so it will perform a deep search for the given properties.
+ * E.g., the function will return `{ a: { b: { c: { test: 1 } } } }` if the properties are  `[ 'test' ]`.
+ *
+ * @param {Object}   object     The object to filter
+ * @param {string[]} properties The properties to filter by
+ * @returns {Object} The merged object.
+ */
+const filterObjectByProperties = ( object: Record< string, any >, properties: string[] ) => {
+	if ( ! object || ! properties?.length ) {
+		return {};
+	}
+
+	const newObject: Record< string, any > = {};
+	Object.keys( object ).forEach( ( key ) => {
+		if ( properties.includes( key ) ) {
+			newObject[ key ] = object[ key ];
+		} else if ( typeof object[ key ] === 'object' ) {
+			const newFilter = filterObjectByProperties(
+				object[ key ] as Record< string, any >,
+				properties
+			);
+			if ( Object.keys( newFilter ).length ) {
+				newObject[ key ] = newFilter;
+			}
+		}
+	} );
+	return newObject;
+};
+
+/**
+ * Compares a style variation to the same variation filtered by the specified properties.
+ * Returns true if the variation contains only the properties specified.
+ *
+ * @param {Object}   variation  The variation to compare.
+ * @param {string[]} properties The properties to compare.
+ * @returns {boolean} Whether the variation contains only the specified properties.
+ */
+const isVariationWithProperties = ( variation: GlobalStylesObject, properties: string[] ) => {
+	const variationWithProperties = filterObjectByProperties(
+		window.structuredClone( variation ),
+		properties
+	);
+
+	return areGlobalStyleConfigsEqual( variationWithProperties, variation );
+};
+
+const isColorVariation = ( variation: GlobalStylesObject ) =>
+	isVariationWithProperties( variation, [ 'color' ] );
+
+const isFontVariation = ( variation: GlobalStylesObject ) =>
+	isVariationWithProperties( variation, [ 'typography' ] );
+
 export {
 	cleanEmptyObject,
 	ExperimentalBlockEditorProvider,
 	GlobalStylesContext,
+	isColorVariation,
+	isFontVariation,
 	transformStyles,
 	useSafeGlobalStylesOutput,
 	useGlobalSetting,