feat: [DHIS2-16123] Add inheritable TEAs to Relationships

src/core_modules/capture-core/components/DataEntries/EnrollmentRegistrationEntry/hooks/useFormValues.js

@@ -8,6 +8,7 @@ import type { RenderFoundation } from '../../../../metaData';
 import { convertClientToForm, convertServerToClient } from '../../../../converters';
 import { subValueGetterByElementType } from './getSubValueForTei';
 import type { QuerySingleResource } from '../../../../utils/api/api.types';
+import { dataElementTypes } from '../../../../metaData';
 
 type InputProgramData = {
     attributes: Array<{
@@ -32,7 +33,7 @@ export type InputAttribute = {
     displayName: string,
     lastUpdated: string,
     value: string,
-    valueType: string,
+    valueType: $Keys<typeof dataElementTypes>,
 };
 
 type InputForm = {
@@ -50,7 +51,7 @@ type StaticPatternValues = {
 
 const useClientAttributesWithSubvalues = (program: InputProgramData, attributes: Array<InputAttribute>) => {
     const dataEngine = useDataEngine();
-    const [listAttributes, setListAttributes] = useState([]);
+    const [listAttributes, setListAttributes] = useState(null);
 
     const getListAttributes = useCallback(async () => {
         if (program && attributes) {
@@ -139,8 +140,6 @@ export const useFormValues = ({ program, trackedEntityInstanceAttributes, orgUni
     const formValuesReadyRef = useRef<any>(false);
     const [formValues, setFormValues] = useState<any>({});
     const [clientValues, setClientValues] = useState<any>({});
-    const areAttributesWithSubvaluesReady =
-        (teiId && clientAttributesWithSubvalues.length > 0) || (!teiId && clientAttributesWithSubvalues.length === 0);
 
     useEffect(() => {
         formValuesReadyRef.current = false;
@@ -152,7 +151,7 @@ export const useFormValues = ({ program, trackedEntityInstanceAttributes, orgUni
             formFoundation &&
             Object.entries(formFoundation).length > 0 &&
             formValuesReadyRef.current === false &&
-            areAttributesWithSubvaluesReady
+            !!clientAttributesWithSubvalues
         ) {
             const staticPatternValues = { orgUnitCode: orgUnit.code };
             const querySingleResource = makeQuerySingleResource(dataEngine.query.bind(dataEngine));
@@ -172,7 +171,6 @@ export const useFormValues = ({ program, trackedEntityInstanceAttributes, orgUni
         clientAttributesWithSubvalues,
         formValuesReadyRef,
         orgUnit,
-        areAttributesWithSubvaluesReady,
         searchTerms,
         dataEngine,
     ]);

src/core_modules/capture-core/components/DataEntries/TeiRegistrationEntry/TeiRegistrationEntry.container.js

@@ -11,19 +11,37 @@ import { useFormValuesFromSearchTerms } from './hooks/useFormValuesFromSearchTer
 import { dataEntryHasChanges } from '../../DataEntry/common/dataEntryHasChanges';
 import { useMetadataForRegistrationForm } from '../common/TEIAndEnrollment/useMetadataForRegistrationForm';
 import { useBuildTeiPayload } from './hooks/useBuildTeiPayload';
+import type { InputAttribute } from '../EnrollmentRegistrationEntry/hooks/useFormValues';
 
-const useInitialiseTeiRegistration = (selectedScopeId, dataEntryId, orgUnitId) => {
+type Props = {
+    selectedScopeId: string,
+    dataEntryId: string,
+    orgUnitId: string,
+    inheritedAttributes: ?Array<InputAttribute>,
+}
+const useInitialiseTeiRegistration = ({
+    selectedScopeId,
+    dataEntryId,
+    orgUnitId,
+    inheritedAttributes,
+}: Props) => {
     const dispatch = useDispatch();
     const { scopeType, trackedEntityName } = useScopeInfo(selectedScopeId);
     const { formId, formFoundation } = useMetadataForRegistrationForm({ selectedScopeId });
-    const formValues = useFormValuesFromSearchTerms();
+    const formValues = useFormValuesFromSearchTerms({ inheritedAttributes });
     const registrationFormReady = !!formId;
 
     useEffect(() => {
         if (registrationFormReady && scopeType === scopeTypes.TRACKED_ENTITY_TYPE) {
             dispatch(
                 startNewTeiDataEntryInitialisation(
-                    { selectedOrgUnitId: orgUnitId, selectedScopeId, dataEntryId, formFoundation, formValues },
+                    {
+                        selectedOrgUnitId: orgUnitId,
+                        selectedScopeId,
+                        dataEntryId,
+                        formFoundation,
+                        formValues,
+                    },
                 ));
         }
     }, [
@@ -43,8 +61,20 @@ const useInitialiseTeiRegistration = (selectedScopeId, dataEntryId, orgUnitId) =
 };
 
 
-export const TeiRegistrationEntry: ComponentType<OwnProps> = ({ selectedScopeId, id, orgUnitId, onSave, ...rest }) => {
-    const { trackedEntityName } = useInitialiseTeiRegistration(selectedScopeId, id, orgUnitId);
+export const TeiRegistrationEntry: ComponentType<OwnProps> = ({
+    selectedScopeId,
+    id,
+    orgUnitId,
+    onSave,
+    inheritedAttributes,
+    ...rest
+}) => {
+    const { trackedEntityName } = useInitialiseTeiRegistration({
+        selectedScopeId,
+        dataEntryId: id,
+        orgUnitId,
+        inheritedAttributes,
+    });
     const ready = useSelector(({ dataEntries }) => (!!dataEntries[id]));
     const dataEntry = useSelector(({ dataEntries }) => (dataEntries[id]));
     const {

src/core_modules/capture-core/components/DataEntries/TeiRegistrationEntry/TeiRegistrationEntry.types.js

@@ -6,6 +6,7 @@ import type { ExistingUniqueValueDialogActionsComponent } from '../withErrorMess
 import type {
     TeiPayload,
 } from '../../Pages/common/TEIRelationshipsWidget/RegisterTei/DataEntry/TrackedEntityInstance/dataEntryTrackedEntityInstance.types';
+import type { InputAttribute } from '../EnrollmentRegistrationEntry/hooks/useFormValues';
 
 export type OwnProps = $ReadOnly<{|
     id: string,
@@ -16,6 +17,7 @@ export type OwnProps = $ReadOnly<{|
     onSave: (TeiPayload) => void,
     duplicatesReviewPageSize: number,
     isSavingInProgress?: boolean,
+    inheritedAttributes?: Array<InputAttribute>,
     renderDuplicatesCardActions?: RenderCustomCardActions,
     renderDuplicatesDialogActions?: (onCancel: () => void, onSave: (TeiPayload) => void) => Node,
     ExistingUniqueValueDialogActions: ExistingUniqueValueDialogActionsComponent,

src/core_modules/capture-core/components/DataEntries/TeiRegistrationEntry/hooks/useFormValuesFromSearchTerms.js

@@ -1,19 +1,32 @@
 // @flow
-import { useEffect, useState } from 'react';
+import { useMemo } from 'react';
 import { useSelector } from 'react-redux';
 import { convertClientToForm } from '../../../../converters';
+import type { InputAttribute } from '../../EnrollmentRegistrationEntry/hooks/useFormValues';
 
+type Props = {
+    inheritedAttributes: ?Array<InputAttribute>,
+};
 
-export const useFormValuesFromSearchTerms = () => {
+export const useFormValuesFromSearchTerms = ({ inheritedAttributes }: Props) => {
     const searchTerms = useSelector(({ searchDomain }) => searchDomain.currentSearchInfo.currentSearchTerms);
-    const [formValues, setFormValues] = useState();
-    useEffect(() => {
+
+    return useMemo(() => {
+        if (inheritedAttributes) {
+            return inheritedAttributes
+                ?.reduce((acc, item) => {
+                    acc[item.attribute] = convertClientToForm(item.value, item.valueType);
+                    return acc;
+                }, {});
+        }
         if (searchTerms) {
-            const searchFormValues = searchTerms
-                ?.reduce((acc, item) => ({ ...acc, [item.id]: convertClientToForm(item.value, item.type) }), {});
-            setFormValues(searchFormValues);
+            return searchTerms
+                ?.reduce((acc, item) => {
+                    acc[item.id] = convertClientToForm(item.value, item.type);
+                    return acc;
+                }, {});
         }
-    }, [searchTerms]);
 
-    return formValues;
+        return null;
+    }, [inheritedAttributes, searchTerms]);
 };

src/core_modules/capture-core/components/FormFields/New/Fields/OrgUnitField/SingleOrgUnitSelectField.component.js

@@ -13,7 +13,7 @@ const getStyles = () => ({
 
 type OrgUnitValue = {
     id: string,
-    name: string,
+    displayName: string,
     path: string,
 }
 
@@ -44,15 +44,15 @@ class SingleOrgUnitSelectFieldPlain extends React.Component<Props, State> {
         const { classes } = this.props;
         return (
             <div className={classes.selectedOrgUnitContainer}>
-                <Chip onRemove={this.onDeselectOrgUnit}>{selectedOrgUnit.name}</Chip>
+                <Chip onRemove={this.onDeselectOrgUnit}>{selectedOrgUnit.displayName}</Chip>
             </div>
         );
     }
 
     onSelectOrgUnit = (orgUnit: Object) => {
         this.props.onBlur({
             id: orgUnit.id,
-            name: orgUnit.displayName,
+            displayName: orgUnit.displayName,
             path: orgUnit.path,
         });
     }

src/core_modules/capture-core/components/Pages/New/NewPage.types.js

@@ -1,5 +1,6 @@
 // @flow
 import { typeof newPageStatuses } from './NewPage.constants';
+import { dataElementTypes } from '../../../metaData';
 
 type ProgramCategories = Array<{|name: string, id: string|}>
 
@@ -10,7 +11,7 @@ type InputAttribute = {
   displayName: string,
   lastUpdated: string,
   value: string,
-  valueType: string,
+  valueType: $Keys<typeof dataElementTypes>,
 };
 
 export type ContainerProps = $ReadOnly<{|

src/core_modules/capture-core/components/Pages/New/RegistrationDataEntry/RegistrationDataEntry.types.js

@@ -1,13 +1,15 @@
 // @flow
 
+import { dataElementTypes } from '../../../../metaData';
+
 type InputAttribute = {
   attribute: string,
   code: string,
   created: string,
   displayName: string,
   lastUpdated: string,
   value: string,
-  valueType: string,
+  valueType: $Keys<typeof dataElementTypes>,
 };
 
 export type OwnProps = $ReadOnly<{|

src/core_modules/capture-core/components/Pages/common/TEIRelationshipsWidget/RegisterTei/DataEntry/Enrollment/DataEntryEnrollment.component.js

@@ -12,6 +12,7 @@ const NewEnrollmentRelationshipPlain =
         theme,
         onSave,
         programId,
+        inheritedAttributes,
         orgUnitId,
         duplicatesReviewPageSize,
         renderDuplicatesDialogActions,
@@ -35,6 +36,7 @@ const NewEnrollmentRelationshipPlain =
                 renderDuplicatesDialogActions={renderDuplicatesDialogActions}
                 renderDuplicatesCardActions={renderDuplicatesCardActions}
                 ExistingUniqueValueDialogActions={ExistingUniqueValueDialogActions}
+                trackedEntityInstanceAttributes={inheritedAttributes}
             />
         );
     };

src/core_modules/capture-core/components/Pages/common/TEIRelationshipsWidget/RegisterTei/DataEntry/Enrollment/dataEntryEnrollment.types.js

@@ -6,11 +6,13 @@ import type {
     SaveForEnrollmentAndTeiRegistration,
     ExistingUniqueValueDialogActionsComponent,
 } from '../../../../../../DataEntries';
+import type { InputAttribute } from '../../../../../../DataEntries/EnrollmentRegistrationEntry/hooks/useFormValues';
 
 export type Props = {|
     theme: Theme,
     programId: string,
     orgUnitId: string,
+    inheritedAttributes: Array<InputAttribute>,
     enrollmentMetadata?: Enrollment,
     onSave: SaveForEnrollmentAndTeiRegistration,
     duplicatesReviewPageSize: number,

src/core_modules/capture-core/components/Pages/common/TEIRelationshipsWidget/RegisterTei/DataEntry/RegisterTeiDataEntry.component.js

@@ -12,7 +12,13 @@ type Props = {
 
 export class RegisterTeiDataEntryComponent extends React.Component<Props> {
     render() {
-        const { showDataEntry, programId, onSaveWithoutEnrollment, onSaveWithEnrollment, ...passOnProps } = this.props;
+        const {
+            showDataEntry,
+            programId,
+            onSaveWithoutEnrollment,
+            onSaveWithEnrollment,
+            ...passOnProps
+        } = this.props;
 
         if (!showDataEntry) {
             return null;

src/core_modules/capture-core/components/Pages/common/TEIRelationshipsWidget/RegisterTei/DataEntry/TrackedEntityInstance/DataEntryTrackedEntityInstance.js

@@ -14,6 +14,7 @@ const RelationshipTrackedEntityInstancePlain =
         theme,
         onSave,
         trackedEntityTypeId,
+        inheritedAttributes,
         duplicatesReviewPageSize,
         renderDuplicatesDialogActions,
         renderDuplicatesCardActions,
@@ -36,6 +37,7 @@ const RelationshipTrackedEntityInstancePlain =
                 orgUnitId={orgUnitId}
                 teiRegistrationMetadata={teiRegistrationMetadata}
                 selectedScopeId={teiRegistrationMetadata.form.id}
+                inheritedAttributes={inheritedAttributes}
                 saveButtonText={i18n.t('Save new {{trackedEntityTypeName}} and link', {
                     trackedEntityTypeName: trackedEntityTypeNameLC, interpolation: { escapeValue: false },
                 })}

src/core_modules/capture-core/components/Pages/common/TEIRelationshipsWidget/RegisterTei/DataEntry/TrackedEntityInstance/dataEntryTrackedEntityInstance.types.js

@@ -5,6 +5,7 @@ import type { RenderCustomCardActions } from '../../../../../../CardList';
 import type {
     ExistingUniqueValueDialogActionsComponent,
 } from '../../../../../../DataEntries';
+import type { InputAttribute } from '../../../../../../DataEntries/EnrollmentRegistrationEntry/hooks/useFormValues';
 
 export type TeiPayload = {|
     trackedEntity: string,
@@ -23,6 +24,7 @@ export type Props = {|
     trackedEntityTypeId: string,
     onSave: TeiPayload => void,
     teiRegistrationMetadata?: TeiRegistration,
+    inheritedAttributes: Array<InputAttribute>,
     duplicatesReviewPageSize: number,
     renderDuplicatesCardActions?: RenderCustomCardActions,
     renderDuplicatesDialogActions?: (onCancel: () => void, onSave: (TeiPayload) => void) => Node,

src/core_modules/capture-core/components/Pages/common/TEIRelationshipsWidget/RegisterTei/RegisterTei.component.js

@@ -64,6 +64,7 @@ const RegisterTeiPlain = ({
     trackedEntityName,
     trackedEntityTypeId,
     selectedScopeId,
+    inheritedAttributes,
     classes,
 }: ComponentProps) => {
     const { resultsPageSize } = useContext(ResultsPageSizeContext);
@@ -110,6 +111,7 @@ const RegisterTeiPlain = ({
                     renderDuplicatesDialogActions={renderDuplicatesDialogActions}
                     renderDuplicatesCardActions={renderDuplicatesCardActions}
                     ExistingUniqueValueDialogActions={ExistingUniqueValueDialogActions}
+                    inheritedAttributes={inheritedAttributes}
                 />
             </div>
             <DataEntryWidgetOutput

src/core_modules/capture-core/components/Pages/common/TEIRelationshipsWidget/RegisterTei/RegisterTei.container.js

@@ -4,18 +4,29 @@ import { useSelector } from 'react-redux';
 import { RegisterTeiComponent } from './RegisterTei.component';
 import type { ContainerProps } from './RegisterTei.types';
 import { useScopeInfo } from '../../../../../hooks';
+import { useInheritedAttributeValues } from '../useInheritedAttributeValues';
 
 export const RegisterTei = ({
     onLink,
     onSave,
     onGetUnsavedAttributeValues,
+    teiId,
     trackedEntityTypeId,
     suggestedProgramId,
 }: ContainerProps) => {
     const dataEntryId = 'relationship';
     const error = useSelector(({ newRelationshipRegisterTei }) => (newRelationshipRegisterTei.error));
     const selectedScopeId = suggestedProgramId || trackedEntityTypeId;
     const { trackedEntityName } = useScopeInfo(selectedScopeId);
+    const { inheritedAttributes, isLoading: isLoadingAttributes } = useInheritedAttributeValues({
+        teiId,
+        trackedEntityTypeId,
+        programId: suggestedProgramId,
+    });
+
+    if (isLoadingAttributes) {
+        return null;
+    }
 
     return (
         <RegisterTeiComponent
@@ -28,6 +39,7 @@ export const RegisterTei = ({
             selectedScopeId={selectedScopeId}
             error={error}
             trackedEntityTypeId={trackedEntityTypeId}
+            inheritedAttributes={inheritedAttributes}
         />
     );
 };

src/core_modules/capture-core/components/Pages/common/TEIRelationshipsWidget/RegisterTei/RegisterTei.types.js

@@ -1,4 +1,6 @@
 // @flow
+import type { InputAttribute } from '../../../../DataEntries/EnrollmentRegistrationEntry/hooks/useFormValues';
+
 export type SharedProps = {|
     onLink: (teiId: string, values: Object) => void,
     onGetUnsavedAttributeValues?: ?Function,
@@ -7,6 +9,7 @@ export type SharedProps = {|
 
 export type ContainerProps = {|
     suggestedProgramId: string,
+    teiId: string,
     onSave: (teiPayload: Object) => void,
     ...SharedProps,
 |};
@@ -16,6 +19,7 @@ export type ComponentProps = {|
     error: string,
     dataEntryId: string,
     trackedEntityName: ?string,
+    inheritedAttributes: Array<InputAttribute>,
     onSaveWithEnrollment: () => void,
     onSaveWithoutEnrollment: () => void,
     ...SharedProps,

src/core_modules/capture-core/components/Pages/common/TEIRelationshipsWidget/TrackedEntityRelationshipsWrapper/TrackedEntityRelationshipsWrapper.component.js

@@ -76,6 +76,7 @@ export const TrackedEntityRelationshipsWrapper = ({
                             suggestedProgramId={suggestedProgramId}
                             onLink={onLinkToTrackedEntityFromSearch}
                             onSave={onLinkToTrackedEntityFromRegistration}
+                            teiId={teiId}
                             onGetUnsavedAttributeValues={() => console.log('get unsaved')}
                             trackedEntityTypeId={selectedTrackedEntityTypeId}
                         />