feat: filter entries by isRead and isStarred (#485)

Author: justlevine

CHANGELOG.md

@@ -3,10 +3,12 @@
 ## [Unreleased]
 
 - feat: Deprecate `PhoneField.phoneFormat` in favor of `PhoneField.phoneFormatType`, and add new `GfPhoneFormat` type.  Props @chetanupare, @justlevine.
+- feat: Add support for filtering entries by `isRead` and `isStarred` statuses.
 - fix: Correctly resolve `AddressField.defaultState`, `AddressField.defaultProvince` based on the `addressType`. H/t @byanko-bot
 - fix: Set the default `AddressField.inputs.label` for the State/Province and Zip/Postal inputs based on the `addressType`. H/t @byanko-bot
 - chore: Update Composer and NPM deps.
 - tests: Improve cleanup and factory instantiation for better local isolation.
+- tests: Backfill tests for Entry connection args.
 
 ## [v0.13.3]
 

src/Connection/EntriesConnection.php

@@ -60,7 +60,7 @@ public static function register(): void {
 					'fromType'       => 'RootQuery',
 					'toType'         => SubmittedEntry::$type,
 					'fromFieldName'  => 'gfSubmittedEntries',
-					'connectionArgs' => self::get_filtered_connection_args( [ 'formIds', 'dateFilters', 'fieldFilters', 'fieldFiltersMode', 'orderby', 'status' ] ),
+					'connectionArgs' => self::get_filtered_connection_args( [ 'formIds', 'dateFilters', 'fieldFilters', 'fieldFiltersMode', 'isRead', 'isStarred', 'orderby', 'status' ] ),
 					'resolve'        => static function ( $root, array $args, AppContext $context, ResolveInfo $info ) {
 						return Factory::resolve_entries_connection( $root, $args, $context, $info );
 					},
@@ -82,10 +82,6 @@ public static function get_connection_args(): array {
 				'type'        => EntryTypeEnum::$type,
 				'description' => static fn () => __( 'Entry status. Default is `SUBMITTED`. Currently no other types are supported.', 'wp-graphql-gravity-forms' ),
 			],
-			'formIds'          => [
-				'type'        => [ 'list_of' => 'ID' ],
-				'description' => static fn () => __( 'Array of form IDs to limit the entries to. Exclude this argument to query all forms.', 'wp-graphql-gravity-forms' ),
-			],
 			'fieldFilters'     => [
 				'type'        => [ 'list_of' => EntriesFieldFiltersInput::$type ],
 				'description' => static fn () => __( 'Field-specific filters to apply.', 'wp-graphql-gravity-forms' ),
@@ -94,6 +90,18 @@ public static function get_connection_args(): array {
 				'type'        => FieldFiltersModeEnum::$type,
 				'description' => static fn () => __( 'Whether to filter by ALL or ANY of the field filters. Default is ALL.', 'wp-graphql-gravity-forms' ),
 			],
+			'formIds'          => [
+				'type'        => [ 'list_of' => 'ID' ],
+				'description' => static fn () => __( 'Array of form IDs to limit the entries to. Exclude this argument to query all forms.', 'wp-graphql-gravity-forms' ),
+			],
+			'isRead'           => [
+				'type'        => 'Boolean',
+				'description' => static fn () => __( 'Whether to limit to read or unread entries. Default is to include both.', 'wp-graphql-gravity-forms' ),
+			],
+			'isStarred'        => [
+				'type'        => 'Boolean',
+				'description' => static fn () => __( 'Whether to limit to starred or unstarred entries. Default is to include both.', 'wp-graphql-gravity-forms' ),
+			],
 			'orderby'          => [
 				'type'        => EntriesConnectionOrderbyInput::$type,
 				'description' => static fn () => __( 'How to sort the entries.', 'wp-graphql-gravity-forms' ),

src/Data/Connection/EntriesConnectionResolver.php

@@ -294,6 +294,28 @@ private function prepare_search_criteria( array $args ): array {
 			);
 		}
 
+		// Add isRead filter to field_filters.
+		if ( isset( $args['where']['isRead'] ) ) {
+			if ( ! isset( $search_criteria['field_filters'] ) ) {
+				$search_criteria['field_filters'] = [ 'mode' => FieldFiltersModeEnum::ALL ];
+			}
+			$search_criteria['field_filters'][] = [
+				'key'   => 'is_read',
+				'value' => (bool) $args['where']['isRead'],
+			];
+		}
+
+		// Add isStarred filter to field_filters.
+		if ( isset( $args['where']['isStarred'] ) ) {
+			if ( ! isset( $search_criteria['field_filters'] ) ) {
+				$search_criteria['field_filters'] = [ 'mode' => FieldFiltersModeEnum::ALL ];
+			}
+			$search_criteria['field_filters'][] = [
+				'key'   => 'is_starred',
+				'value' => (bool) $args['where']['isStarred'],
+			];
+		}
+
 		return $search_criteria;
 	}