feat: use configured TEA Search Operators in the Search page

Author: simonadomnisoru

i18n/en.pot

@@ -5,8 +5,8 @@ msgstr ""
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=(n != 1)\n"
-"POT-Creation-Date: 2025-10-23T11:41:11.943Z\n"
-"PO-Revision-Date: 2025-10-23T11:41:11.943Z\n"
+"POT-Creation-Date: 2025-12-02T08:24:37.493Z\n"
+"PO-Revision-Date: 2025-12-02T08:24:37.493Z\n"
 
 msgid "Choose one or more dates..."
 msgstr "Choose one or more dates..."
@@ -534,6 +534,15 @@ msgstr "Clear"
 msgid "No results"
 msgstr "No results"
 
+msgid "Exact matches only"
+msgstr "Exact matches only"
+
+msgid "Must match the start of the value"
+msgstr "Must match the start of the value"
+
+msgid "Must match the end of the value"
+msgstr "Must match the end of the value"
+
 msgid "Description"
 msgstr "Description"
 
@@ -2138,7 +2147,7 @@ msgid ""
 "The following attribute type is not supported for searching and has been "
 "hidden"
 msgid_plural ""
-"The following attribute types is not supported for searching and has been "
+"The following attribute type is not supported for searching and has been "
 "hidden"
 msgstr[0] ""
 "The following attribute type is not supported for searching and has been "

src/core_modules/capture-core/components/D2Form/field/Components/AgeField/AgeFieldForForm.component.ts

@@ -10,6 +10,7 @@ import {
     withDisplayMessages,
     withFilterProps,
     withInternalChangeHandler,
+    withSearchHelpMessage,
 } from '../../../../FormFields/New';
 import {
     withRequiredFieldCalculation,
@@ -36,8 +37,10 @@ export const AgeFieldForForm = withGotoInterface()(
                                         `${props.fieldLabelMediaBasedClass} ${labelTypeClasses.ageLabel}`,
                                 })(
                                     withDisplayMessages()(
-                                        withFilterProps(getFilteredProps)(
-                                            withInternalChangeHandler()(AgeField),
+                                        withSearchHelpMessage()(
+                                            withFilterProps(getFilteredProps)(
+                                                withInternalChangeHandler()(AgeField),
+                                            ),
                                         ),
                                     ),
                                 ),

src/core_modules/capture-core/components/D2Form/field/Components/BooleanField/BooleanFieldForForm.component.ts

@@ -9,6 +9,7 @@ import {
     withLabel,
     withDisplayMessages,
     withFilterProps,
+    withSearchHelpMessage,
 } from '../../../../FormFields/New';
 import {
     withRequiredFieldCalculation,
@@ -35,7 +36,9 @@ export const BooleanFieldForForm = withGotoInterface()(
                                         `${props.fieldLabelMediaBasedClass} ${labelTypeClasses.booleanLabel}`,
                                 })(
                                     withFilterProps(getFilteredProps)(
-                                        withDisplayMessages()(BooleanField),
+                                        withDisplayMessages()(
+                                            withSearchHelpMessage()(BooleanField),
+                                        ),
                                     ),
                                 ),
                             ),

src/core_modules/capture-core/components/D2Form/field/Components/OptionSetField/OptionSetSelectFieldForForm.component.ts

@@ -11,6 +11,7 @@ import {
     withDisplayMessages,
     withFilterProps,
     withOptionsIconElement,
+    withSearchHelpMessage,
 } from '../../../../FormFields/New';
 import {
     withRequiredFieldCalculation,
@@ -38,10 +39,12 @@ export const OptionSetSelectFieldForForm = withGotoInterface()(
                                         `${props.fieldLabelMediaBasedClass} ${labelTypeClasses.textLabel}`,
                                 })(
                                     withDisplayMessages()(
-                                        withOptionsIconElement()(
-                                            withRulesOptionVisibilityHandler()(
-                                                withFilterProps(getFilteredProps)(
-                                                    withSelectTranslations()(VirtualizedSelectField),
+                                        withSearchHelpMessage()(
+                                            withOptionsIconElement()(
+                                                withRulesOptionVisibilityHandler()(
+                                                    withFilterProps(getFilteredProps)(
+                                                        withSelectTranslations()(VirtualizedSelectField),
+                                                    ),
                                                 ),
                                             ),
                                         ),

src/core_modules/capture-core/components/D2Form/field/Components/OrgUnitField/OrgUnitFieldForForm.component.ts

@@ -9,6 +9,7 @@ import {
     withInternalChangeHandler,
     withFilterProps,
     SingleOrgUnitSelectField,
+    withSearchHelpMessage,
 } from '../../../../FormFields/New';
 import {
     withRequiredFieldCalculation,
@@ -36,9 +37,11 @@ export const OrgUnitFieldForForm = withGotoInterface()(
                             })(
                                 withFilterProps(getFilteredProps)(
                                     withDisplayMessages()(
-                                        withInternalChangeHandler()(
-                                            withFormFieldOrgUnitsHandler()(
-                                                SingleOrgUnitSelectField,
+                                        withSearchHelpMessage()(
+                                            withInternalChangeHandler()(
+                                                withFormFieldOrgUnitsHandler()(
+                                                    SingleOrgUnitSelectField,
+                                                ),
                                             ),
                                         ),
                                     ),

src/core_modules/capture-core/components/D2Form/field/Components/TextField/TextFieldForForm.component.ts

@@ -8,6 +8,7 @@ import {
     withDefaultFieldContainer,
     withLabel,
     withDisplayMessages,
+    withSearchHelpMessage,
     withInternalChangeHandler,
     withFilterProps,
 } from '../../../../FormFields/New';
@@ -37,7 +38,9 @@ export const TextFieldForForm = withGotoInterface()(
                                 })(
                                     withFilterProps(getFilteredProps)(
                                         withDisplayMessages()(
-                                            withInternalChangeHandler()(TextField),
+                                            withSearchHelpMessage()(
+                                                withInternalChangeHandler()(TextField),
+                                            ),
                                         ),
                                     ),
                                 ),

src/core_modules/capture-core/components/D2Form/field/Components/TrueOnlyField/TrueOnlyFieldForForm.component.ts

@@ -9,6 +9,7 @@ import {
     withLabel,
     withDisplayMessages,
     withFilterProps,
+    withSearchHelpMessage,
 } from '../../../../FormFields/New';
 import {
     withRequiredFieldCalculation,
@@ -35,7 +36,9 @@ export const TrueOnlyFieldForForm = withGotoInterface()(
                                         `${props.fieldLabelMediaBasedClass} ${labelTypeClasses.trueOnlyLabel}`,
                                 })(
                                     withFilterProps(getFilteredProps)(
-                                        withDisplayMessages()(TrueOnlyField),
+                                        withDisplayMessages()(
+                                            withSearchHelpMessage()(TrueOnlyField),
+                                        ),
                                     ),
                                 ),
                             ),

src/core_modules/capture-core/components/D2Form/field/Components/UserNameField/UserNameFieldForForm.component.ts

@@ -10,6 +10,7 @@ import {
     withDisplayMessages,
     withFilterProps,
     withInternalChangeHandler,
+    withSearchHelpMessage,
 } from '../../../../FormFields/New';
 import {
     withRequiredFieldCalculation,
@@ -37,9 +38,11 @@ export const UserNameFieldForForm = withGotoInterface()(
                                         `${props.fieldLabelMediaBasedClass} ${labelTypeClasses.textLabel}`,
                                 })(
                                     withDisplayMessages()(
-                                        withFilterProps(getFilteredProps)(
-                                            withTransformPropName(['onBlur', 'onSet'])(
-                                                withInternalChangeHandler()(UserField),
+                                        withSearchHelpMessage()(
+                                            withFilterProps(getFilteredProps)(
+                                                withTransformPropName(['onBlur', 'onSet'])(
+                                                    withInternalChangeHandler()(UserField),
+                                                ),
                                             ),
                                         ),
                                     ),

src/core_modules/capture-core/components/D2Form/field/configs/base/configBaseDefaultForm.ts

@@ -24,13 +24,14 @@ const baseComponentStylesVertical = {
     },
 };
 
-const getBaseProps = ({ formName, compulsory, disabled, unique, icon, description, url }: DataElement) => ({
+const getBaseProps = ({ formName, compulsory, disabled, unique, icon, description, url, searchOperator }: DataElement) => ({
     description,
     url,
     styles: baseComponentStyles,
     label: formName,
     metaCompulsory: compulsory,
     metaDisabled: disabled || (unique && unique.generatable),
+    searchOperator,
     icon: icon ? {
         name: icon.name,
         color: icon.color,

src/core_modules/capture-core/components/FormFields/New/HOC/messages/withSearchHelpMessage.tsx

@@ -0,0 +1,44 @@
+import * as React from 'react';
+import i18n from '@dhis2/d2-i18n';
+import { colors } from '@dhis2/ui';
+import { withStyles, WithStyles } from '@material-ui/core/styles';
+
+const styles = (theme: any) => ({
+    help: {
+        marginLeft: 0,
+        paddingLeft: 0,
+        color: colors.grey700,
+        fontSize: theme.typography.pxToRem(14),
+    },
+});
+
+type Props = {
+    searchOperator?: string;
+};
+
+const helpTexts = {
+    EQ: i18n.t('Exact matches only'),
+    SW: i18n.t('Must match the start of the value'),
+    EW: i18n.t('Must match the end of the value'),
+};
+
+const getSearchHelpMessageHOC = <P extends Record<string, any>>(InnerComponent: React.ComponentType<P>) =>
+    class DisplayMessagesHOC extends React.Component<P & Props & WithStyles<typeof styles>> {
+        render() {
+            const { classes, searchOperator, ...passOnProps } = this.props;
+            const helpText = searchOperator && helpTexts[searchOperator];
+
+            return (
+                <>
+                    <InnerComponent {...passOnProps as unknown as P} />
+                    {helpText && <div className={classes.help}>
+                        {helpText} <br />
+                    </div>
+                    }
+                </>
+            );
+        }
+    };
+
+export const withSearchHelpMessage = () => <P extends Record<string, any>>(InnerComponent: React.ComponentType<P>) =>
+    withStyles(styles)(getSearchHelpMessageHOC(InnerComponent) as any);