feat: allow multiple filter values, fixes #7328

[paulroub]

Summary

Allows a collection filter to match one of a number of values; still allows the existing single-value syntax, as well as an array of values.

Need to manage a collection that's a combination of existing categories (rather than re-categorize all those posts).

Test plan

• Added a unit test for the array variation, existing (non-array) tests still path.
• Tested against my collections, with single-value, single-element-array and multiple-element-array variations all working as expected.

Checklist

Please add a x inside each checkbox:

• I have read the contribution guidelines.
• I have added a documentation update PR at feat: allow multiple filter values decap-website#92

A picture of a cute animal (not mandatory but encouraged)

[martinjagodic]

@paulroub, thanks for your contribution. Before we review, can you please ensure the tests are passing?

[paulroub]

@martinjagodic Fixed the linting issues, along the way had to tell stylelint to ignore backend.ts as it was trying to parse a cast as CSS and was not happy with the result. No actual styles in this file, of course, so that should be harmless.

[paulroub]

Rebased on current main, confirmed npx run test:all still succeeds.

[Copilot]

Pull Request Overview

Adds the ability for collection filters to match against multiple values by updating the value type, normalizing inputs, and enhancing the filter logic.

• Expand FilterRule.value to accept arrays, Immutable List, or typed records
• Normalize raw filter and field values via a new valuesAsArray helper
• Update filterEntries to use normalized arrays and add a corresponding unit test
• Ignore backend.ts in Stylelint to prevent lint failures on new code

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File	Description
packages/decap-cms-core/src/types/redux.ts	Broaden FilterRule.value type to support multi-value inputs
packages/decap-cms-core/src/backend.ts	Implement valuesAsArray and update filterEntries for arrays
packages/decap-cms-core/src/tests/backend.spec.js	Add test covering array-based filter values
.stylelintrc	Include src/backend.ts in lint ignore list

Comments suppressed due to low confidence (1)

packages/decap-cms-core/src/tests/backend.spec.js:98

• This test covers plain arrays but doesn't verify behavior when value or entry.data[field] are Immutable List or StaticallyTypedRecord<List<string>>. Add tests for those types to ensure full coverage of the new normalization logic.

    it('filters multiple values', () => {

[martinjagodic]

@paulroub it's been a while, I hope this is still relevant to you.

When I try this with my test config, the collection fails to load entries - even before I tried the list of filters. See screenshot below.

I also have an idea of extending this further by adding an operator like with the condition field.

Condition example:

condition: {
  field: layout,
  value: list-filters,
  operator: '!='
}

Maybe we should combine these functions, as it's potentially the same feature on a different level.

[paulroub]

When I try this with my test config, the collection fails to load entries - even before I tried the list of filters. See screenshot below.

I'm so far unable to reproduce this -- any chance you could share your test config?

[paulroub]

When I try this with my test config, the collection fails to load entries - even before I tried the list of filters. See screenshot below.

Reproduced, fixed, added a test case. We were assuming the presence of the filtered-on field on all
entries in the collection. Now just failing the match if (e.g.) we're filtering on "category" but a post doesn't have one.

I also have an idea of extending this further by adding an operator like with the condition field.

I had considered that as well, and poked at it a bit. I hadn't considered extending the syntax, that would make things much more doable.

Perhaps a follow-on? This version seems useful on its own.

[martinjagodic]

Great, thanks! We can do that in a later PR, I agree. If all is ok now, we should merge this for the 3.9 release.

[martinjagodic]

If I add an array as value in dev-test.yaml to the Posts collection like this

collections: # A list of collections the CMS should be able to edit
  - name: 'posts' # Used in routes, ie.: /admin/collections/:slug/edit
    filter: {field: title, value: ['This is post # 20']}

I should see one post entry, but I get these errors in console:

Warning: Failed prop type: Invalid prop `children` supplied to `ErrorBoundary`, expected a ReactNode. 

Warning: Failed prop type: Invalid prop `children` supplied to `Modal`, expected a ReactNode.

Uncaught (in promise) {type: 'ENTRIES_FAILURE', error: 'Failed to load entries', payload: 'TypeError: rawValue.toJS(...).toArray is not a function', meta: {…}}