Allow Filtering on Internal Documents for RichText Block LinkFeature

[tistocks]

Currently, the RichText Block LinkFeature only supports filtering the collections. However, for complicated sites (for example, multi-tenant), this does not support filtering what document within the collection should be displayed. Of course, access control on the included collection will limit to only the documents users can access, but that's not sufficient for many more complicated use cases. It would be nice to support further filtering of the documents based on the current document.

For example, my specific use case:

In a multi-tenanted site, a document with a RichText Block should not support linking to a document in a different Tenant (even though they are in the same collection).

I have a changes set that demonstrates this change, but I need some help from the team to get it in as I have never contributed to Payload in the past.

[AlessioGr]

You can override the doc relationship link field and inject your own filterOptions

[tistocks]

Maybe I'm missing something but I'm not seeing that on the LinkFeature props as an option:
I'm looking for something like this:

Of course the console.log() was only for my testing, this would be the demonstrated use case not the code changes.

import { Block, Where } from "payload";
import { BlockDefault } from "../BlockDefault";
import { FixedToolbarFeature, lexicalEditor, LinkFeature } from '../../../../dist/hacked/richtext-lexical';
import { Entity } from "@backend/collections/names";
import { getContentById } from "@backend/utils/content/getContentById";

export const RichTextBlock: Block = {
    slug: 'rich-text',
    interfaceName: 'RichTextBlockDef',
    labels: {
        singular: 'Rich Text',
        plural: 'Rich Text',
    },
    fields: [
        ...BlockDefault,
        {
            name: 'content',
            label: 'Content',
            type: 'richText',
            editor: lexicalEditor({
                features({ defaultFeatures, rootFeatures, }) {
                    return [
                        FixedToolbarFeature(),
                        ...rootFeatures,
                        LinkFeature({
                            filterOptions: async (props) => {
                                console.log(`Link Feature filterOptions Called: ${props.relationTo}`);
                                console.log(`Currently editing document: ${props.id}`);
                                if (props.relationTo === Entity.TenantContent) {
                                    const doc = await getContentById(props.id as string);
                                    const tenant = doc?.metadata?.contentMetadata?.tenant;
                                    if (tenant) {
                                        const where: Where = {
                                            'metadata.contentMetadata.tenant': {
                                                equals: tenant
                                            },
                                        };
                                        return where;
                                    }
                                }
                                return true;
                            },
                            enabledCollections: [
                                Entity.TenantContent,
                            ]
                        }),
                    ];
                },
            }),
        },
    ],
}

[tistocks]

@AlessioGr Does this provide more clarity on what I was seeking?

[AlessioGr]

Yep - you can add your own filterOptions by overriding the doc relationship field. Here's an example:

LinkFeature({
      fields: ({ defaultFields }) => {
        const docField: RelationshipField = defaultFields.find(
          (field) => field.name === 'doc',
        ) as RelationshipField

        const newDocField: RelationshipField = {
          ...docField,
          filterOptions: () => {
            return true
          },
        }
        return [...defaultFields.filter((field) => field.name !== 'doc'), newDocField]
      },
    })

[tistocks]

I didn't notice that fields could also be a function. That's brilliant, however, I never would have figured that out from the docs. Maybe they should be expanded here.