feat: allow async relationship filter options (#2951)

* chore: improving relationship filter options;

Updating prop filterOptions from field type "relationship" to allow async functions;

* chore: add failing test case

* fix: translation followingFieldsInvalid_many not getting triggered

* docs: improve documentation

---------

Co-authored-by: Alessio Gravili <alessio@gravili.de>

Author: jordyalcides

docs/fields/relationship.mdx

@@ -74,7 +74,7 @@ Set to `false` if you'd like to disable the ability to create new documents from
 
 Options can be dynamically limited by supplying a [query constraint](/docs/queries/overview), which will be used both for validating input and filtering available relationships in the UI.
 
-The `filterOptions` property can either be a `Where` query directly, or a function that returns one. When using a function, it will be called with an argument object with the following properties:
+The `filterOptions` property can either be a `Where` query directly, or a function (synchronous or asynchronous) that returns one. When using a function, it will be called with an argument object containing the following properties:
 
 | Property      | Description                                                                          |
 | ------------- | ------------------------------------------------------------------------------------ |

src/admin/components/forms/field-types/getFilterOptionsQuery.ts

@@ -1,14 +1,14 @@
 import { Where } from '../../../../types';
 import { FilterOptions, FilterOptionsProps } from '../../../../fields/config/types';
 
-export const getFilterOptionsQuery = (filterOptions: FilterOptions, options: Omit<FilterOptionsProps, 'relationTo'> & { relationTo: string | string[] }): {[collection: string]: Where } => {
+export const getFilterOptionsQuery = async (filterOptions: FilterOptions, options: Omit<FilterOptionsProps, 'relationTo'> & { relationTo: string | string[] }): Promise<{[collection: string]: Where }> => {
   const { relationTo } = options;
   const relations = Array.isArray(relationTo) ? relationTo : [relationTo];
   const query = {};
   if (typeof filterOptions !== 'undefined') {
-    relations.forEach((relation) => {
-      query[relation] = typeof filterOptions === 'function' ? filterOptions({ ...options, relationTo: relation }) : filterOptions;
-    });
+    await Promise.all(relations.map(async (relation) => {
+      query[relation] = typeof filterOptions === 'function' ? await filterOptions({ ...options, relationTo: relation }) : filterOptions;
+    }));
   }
   return query;
 };

src/admin/components/utilities/GetFilterOptions/index.tsx

@@ -32,17 +32,20 @@ export const GetFilterOptions = ({
     const data = reduceFieldsToValues(fields, true);
     const siblingData = getSiblingData(fields, path);
 
-    const newFilterOptionsResult = getFilterOptionsQuery(filterOptions, {
-      id,
-      data,
-      relationTo,
-      siblingData,
-      user,
-    });
+    const getFilterOptions = async () => {
+      const newFilterOptionsResult = await getFilterOptionsQuery(filterOptions, {
+        id,
+        data,
+        relationTo,
+        siblingData,
+        user,
+      });
 
-    if (!equal(newFilterOptionsResult, filterOptionsResult)) {
-      setFilterOptionsResult(newFilterOptionsResult);
-    }
+      if (!equal(newFilterOptionsResult, filterOptionsResult)) {
+        setFilterOptionsResult(newFilterOptionsResult);
+      }
+    };
+    getFilterOptions();
   }, [
     fields,
     filterOptions,

src/fields/config/types.ts

@@ -56,7 +56,7 @@ export type FilterOptionsProps<T = any> = {
   relationTo: string,
 }
 
-export type FilterOptions<T = any> = Where | ((options: FilterOptionsProps<T>) => Where);
+export type FilterOptions<T = any> = Where | ((options: FilterOptionsProps<T>) => (Where | Promise<Where>));
 
 type Admin = {
   position?: 'sidebar';

src/fields/validations.ts

@@ -211,7 +211,7 @@ const validateFilterOptions: Validate = async (value, { t, filterOptions, id, us
     const values = Array.isArray(value) ? value : [value];
 
     await Promise.all(collections.map(async (collection) => {
-      const optionFilter = typeof filterOptions === 'function' ? filterOptions({
+      const optionFilter = typeof filterOptions === 'function' ? await filterOptions({
         id,
         data,
         siblingData,

src/translations/ar.json

@@ -63,7 +63,7 @@
     "deletingFile": "حدث خطأ أثناء حذف الملف.",
     "deletingTitle": "حدث خطأ أثناء حذف {{title}}. يرجى التحقق من الاتصال الخاص بك والمحاولة مرة أخرى.",
     "emailOrPasswordIncorrect": "البريد الإلكتروني أو كلمة المرور المقدمة غير صحيحة.",
-    "followingFieldsInvalid_many": "الحقول التالية غير صالحة:",
+    "followingFieldsInvalid_other": "الحقول التالية غير صالحة:",
     "followingFieldsInvalid_one": "الحقل التالي غير صالح:",
     "incorrectCollection": "مجموعة غير صحيحة",
     "invalidFileType": "نوع ملف غير صالح",
@@ -346,4 +346,4 @@
     "viewingVersions": "عرض النسخ لـ {{entityLabel}} {{documentTitle}}",
     "viewingVersionsGlobal": "عرض النسخ للـ {{entityLabel}} العام"
   }
-}
+}

src/translations/bg.json

@@ -63,7 +63,7 @@
     "deletingFile": "Имаше грешка при изтриването на файла.",
     "deletingTitle": "Имаше проблем при изтриването на {{title}}. Моля провери връзката си и опитай отново.",
     "emailOrPasswordIncorrect": "Имейлът или паролата не са правилни.",
-    "followingFieldsInvalid_many": "Следните полета са некоректни:",
+    "followingFieldsInvalid_other": "Следните полета са некоректни:",
     "followingFieldsInvalid_one": "Следното поле е некоректно:",
     "incorrectCollection": "Некоректно събиране",
     "invalidFileType": "Невалиден тип на файл",
@@ -346,4 +346,4 @@
     "viewingVersions": "Гледане на версии за {{entityLabel}} {{documentTitle}}",
     "viewingVersionsGlobal": "Гледане на версии за глобалния документ {{entityLabel}}"
   }
-}
+}

src/translations/cs.json

@@ -63,7 +63,7 @@
     "deletingFile": "Při mazání souboru došlo k chybě.",
     "deletingTitle": "Při mazání {{title}} došlo k chybě. Zkontrolujte své připojení a zkuste to znovu.",
     "emailOrPasswordIncorrect": "Zadaný email nebo heslo není správné.",
-    "followingFieldsInvalid_many": "Následující pole jsou neplatná:",
+    "followingFieldsInvalid_other": "Následující pole jsou neplatná:",
     "followingFieldsInvalid_one": "Následující pole je neplatné:",
     "incorrectCollection": "Nesprávná kolekce",
     "invalidFileType": "Neplatný typ souboru",
@@ -346,4 +346,4 @@
     "viewingVersions": "Zobrazuji verze pro {{entityLabel}} {{documentTitle}}",
     "viewingVersionsGlobal": "Zobrazuji verze pro globální {{entityLabel}}"
   }
-}
+}

src/translations/de.json

@@ -63,7 +63,7 @@
     "deletingFile": "Beim Löschen der Datei ist ein Fehler aufgetreten.",
     "deletingTitle": "Es gab ein Problem während der Löschung von {{title}}. Bitte überprüfe deine Verbindung und versuche es erneut.",
     "emailOrPasswordIncorrect": "Die E-Mail-Adresse oder das Passwort sind nicht korrekt.",
-    "followingFieldsInvalid_many": "Die folgenden Felder sind nicht korrekt:",
+    "followingFieldsInvalid_other": "Die folgenden Felder sind nicht korrekt:",
     "followingFieldsInvalid_one": "Das folgende Feld ist nicht korrekt:",
     "incorrectCollection": "Falsche Sammlung",
     "invalidFileType": "Ungültiger Datei-Typ",
@@ -346,4 +346,4 @@
     "viewingVersions": "Betrachte Versionen für {{entityLabel}} {{documentTitle}}",
     "viewingVersionsGlobal": "`Betrachte Versionen für das Globale Dokument {{entityLabel}}"
   }
-}
+}

src/translations/en.json

@@ -63,7 +63,7 @@
     "deletingFile": "There was an error deleting file.",
     "deletingTitle": "There was an error while deleting {{title}}. Please check your connection and try again.",
     "emailOrPasswordIncorrect": "The email or password provided is incorrect.",
-    "followingFieldsInvalid_many": "The following fields are invalid:",
+    "followingFieldsInvalid_other": "The following fields are invalid:",
     "followingFieldsInvalid_one": "The following field is invalid:",
     "incorrectCollection": "Incorrect Collection",
     "invalidFileType": "Invalid file type",
@@ -346,4 +346,4 @@
     "viewingVersions": "Viewing versions for the {{entityLabel}} {{documentTitle}}",
     "viewingVersionsGlobal": "Viewing versions for the global {{entityLabel}}"
   }
-}
+}