JNG-5402 mask api in actions (#289)

BlackBeltTechnology · Jan 9, 2024 · 9963a75 · 9963a75
1 parent 2497663
commit 9963a75
Show file tree

Hide file tree

Showing 20 changed files with 47 additions and 35 deletions.
diff --git a/judo-ui-react/src/main/resources/actor/src/containers/components/table.tsx.hbs b/judo-ui-react/src/main/resources/actor/src/containers/components/table.tsx.hbs
@@ -93,6 +93,7 @@ export interface {{ componentName table }}ActionDefinitions {
   {{ else }}
     {{# if actionDefinition.isRefreshAction }}
       {{ simpleActionDefinitionName actionDefinition }}?: (queryCustomizer: {{ classDataName (getReferenceClassType table) 'QueryCustomizer' }}) => Promise<{{ classDataName (getReferenceClassType table) 'Stored' }}[]>;
+      get{{ firstToUpper table.relationName }}Mask?: () => string;
     {{ else }}
       {{# if actionDefinition.isSelectorRangeAction }}
         {{ simpleActionDefinitionName actionDefinition }}?: (queryCustomizer: {{ classDataName (getReferenceClassType table) 'QueryCustomizer' }}) => Promise<{{ classDataName (getReferenceClassType table) 'Stored' }}[]>;
@@ -478,17 +479,19 @@ export function {{ componentName table }}(props: {{ componentName table }}Props)
       setIsLoading(true);
 
       try {
+        const processedQueryCustomizer = {
+          ...processQueryCustomizer(queryCustomizer),
+          {{# if (getRefreshActionDefinitionForTable table) }}
+          _mask: actions.get{{ firstToUpper table.relationName }}Mask ? actions.get{{ firstToUpper table.relationName }}Mask() : queryCustomizer._mask,
+          {{/ if }}
+        };
         {{# if container.isSelector }}
         {{# with (getRangeActionDefinitionForTable table) as |actionDefinition| }}
-        const res = await actions.{{ simpleActionDefinitionName actionDefinition }}!(
-          processQueryCustomizer(queryCustomizer),
-        );
+        const res = await actions.{{ simpleActionDefinitionName actionDefinition }}!(processedQueryCustomizer);
         {{/ with }}
         {{ else }}
         {{# with (getRefreshActionDefinitionForTable table) as |actionDefinition| }}
-        const res = await actions.{{ simpleActionDefinitionName actionDefinition }}!(
-          processQueryCustomizer(queryCustomizer),
-        );
+        const res = await actions.{{ simpleActionDefinitionName actionDefinition }}!(processedQueryCustomizer);
         {{/ with }}
         {{/ if }}
 
@@ -629,11 +632,17 @@ export function {{ componentName table }}(props: {{ componentName table }}Props)
                   }
                   {{/ if }}
                   {{ else }}
+                  const processedQueryCustomizer = {
+                    ...processQueryCustomizer(queryCustomizer),
+                    {{# if (getRefreshActionDefinitionForTable table) }}
+                    _mask: actions.get{{ firstToUpper table.relationName }}Mask ? actions.get{{ firstToUpper table.relationName }}Mask() : queryCustomizer._mask,
+                    {{/ if }}
+                  };
                   {{# if actionDefinition.isRefreshAction }}
-                  await actions.{{ simpleActionDefinitionName actionDefinition }}!(processQueryCustomizer(queryCustomizer));
+                  await actions.{{ simpleActionDefinitionName actionDefinition }}!(processedQueryCustomizer);
                   {{ else }}
                   {{# if actionDefinition.isSelectorRangeAction }}
-                  await actions.{{ simpleActionDefinitionName actionDefinition }}!(processQueryCustomizer(queryCustomizer));
+                  await actions.{{ simpleActionDefinitionName actionDefinition }}!(processedQueryCustomizer);
                   {{ else }}
                   {{# if actionDefinition.isBulk }}
                   const { result: bulkResult } = await actions.{{ simpleActionDefinitionName actionDefinition }}!(selectedRows.current);

diff --git a/judo-ui-react/src/main/resources/actor/src/containers/container.tsx.hbs b/judo-ui-react/src/main/resources/actor/src/containers/container.tsx.hbs
@@ -52,6 +52,9 @@ export interface {{ pageContainerActionDefinitionTypeName container }}{{# if (co
   {{# each (getElementsWithHiddenBy container) as |ve| }}
     is{{ safeName ve }}Hidden?: ({{{ inputModifierParams container false }}}) => boolean;
   {{/ each }}
+  {{# if container.view }}
+    getMask?: () => string;
+  {{/ if }}
 }
 {{/ unless }}
 

diff --git a/judo-ui-react/src/main/resources/actor/src/containers/dialog.tsx.hbs b/judo-ui-react/src/main/resources/actor/src/containers/dialog.tsx.hbs
@@ -94,7 +94,7 @@ export default function {{ containerComponentName container }}Dialog(props: {{ c
     } = props;
     {{# unless container.table }}
       const queryCustomizer: {{ classDataName container.dataElement 'QueryCustomizer' }} = {
-        _mask: '{{ getMaskForView container }}',
+        _mask: {{# unless container.form }}actions.getMask ? actions.getMask!() : {{/ unless }}'{{ getMaskForView container }}',
       };
     {{/ unless }}
   {{/ unless }}
@@ -103,7 +103,7 @@ export default function {{ containerComponentName container }}Dialog(props: {{ c
     <>
       {{# unless (containerIsEmptyDashboard container) }}
         <DialogTitle>
-          {actions?.getPageTitle ? actions?.getPageTitle({{# unless container.table }}data{{/ unless }}) : ''}
+          {actions.getPageTitle ? actions.getPageTitle({{# unless container.table }}data{{/ unless }}) : ''}
           <IconButton
             id="{{ getXMIID container }}-dialog-close-wrapper"
             aria-label="close"

diff --git a/judo-ui-react/src/main/resources/actor/src/containers/page.tsx.hbs b/judo-ui-react/src/main/resources/actor/src/containers/page.tsx.hbs
@@ -64,7 +64,7 @@ export default function {{ containerComponentName container }}Page (props: {{ co
     const { actions, isLoading, editMode, refreshCounter{{# unless container.table }}, data, isFormUpdateable, isFormDeleteable, storeDiff, validation, setValidation, submit{{/ unless }} } = props;
     {{# unless container.table }}
       const queryCustomizer: {{ classDataName container.dataElement 'QueryCustomizer' }} = {
-        _mask: '{{ getMaskForView container }}',
+        _mask: {{# unless container.form }}actions.getMask ? actions.getMask!() : {{/ unless }}'{{ getMaskForView container }}',
       };
     {{/ unless }}
   {{/ unless }}

diff --git a/judo-ui-react/src/main/resources/actor/src/dialogs/index.tsx.hbs b/judo-ui-react/src/main/resources/actor/src/dialogs/index.tsx.hbs
@@ -218,9 +218,9 @@ export default function {{ pageName page }}(props: {{ pageName page }}Props) {
       }, [data]);
 
       {{# if page.container.view }}
-        const pageQueryCustomizer: {{ classDataName (getReferenceClassType page) 'QueryCustomizer' }} = {
-          _mask: '{{ getMaskForView page.container }}',
-        };
+        const getPageQueryCustomizer: () => {{ classDataName (getReferenceClassType page) 'QueryCustomizer' }} = () => ({
+          _mask: actions.getMask ? actions.getMask!() : '{{ getMaskForView page.container }}',
+        });
       {{/ if }}
     {{/ unless }}
 
@@ -244,7 +244,7 @@ export default function {{ pageName page }}(props: {{ pageName page }}Props) {
         {{# if page.container.view }}
           {{# with (getRefreshActionDefinitionForContainer page.container) as |refreshActionDefinition| }}
             if (actions.{{ simpleActionDefinitionName refreshActionDefinition }}) {
-              await actions.{{ simpleActionDefinitionName refreshActionDefinition }}!(processQueryCustomizer(pageQueryCustomizer));
+              await actions.{{ simpleActionDefinitionName refreshActionDefinition }}!(processQueryCustomizer(getPageQueryCustomizer()));
             }
           {{/ with }}
         {{/ if }}
@@ -319,7 +319,7 @@ export default function {{ pageName page }}(props: {{ pageName page }}Props) {
     // Effect section
     {{# if (pageShouldInitialize page) }}
       useEffect(() => {
-        actions.{{ simpleActionDefinitionName page.container.onInit }}!({{# if page.container.view }}pageQueryCustomizer{{/ if }});
+        actions.{{ simpleActionDefinitionName page.container.onInit }}!({{# if page.container.view }}getPageQueryCustomizer(){{/ if }});
       }, []);
     {{/ if }}
   {{/ unless }}

diff --git a/...-ui-react/src/main/resources/actor/src/pages/actions/BulkCallOperationAction.fragment.hbs b/...-ui-react/src/main/resources/actor/src/pages/actions/BulkCallOperationAction.fragment.hbs
@@ -27,7 +27,7 @@ const {{ simpleActionDefinitionName action.actionDefinition }} = async (selected
           {{# if page.container.view }}
             {{# with (getRefreshActionDefinitionForContainer page.container) as |refreshActionDefinition| }}
               if (actions.{{ simpleActionDefinitionName refreshActionDefinition }}) {
-                await actions.{{ simpleActionDefinitionName refreshActionDefinition }}!(processQueryCustomizer(pageQueryCustomizer));
+                await actions.{{ simpleActionDefinitionName refreshActionDefinition }}!(processQueryCustomizer(getPageQueryCustomizer()));
               }
             {{/ with }}
           {{/ if }}

diff --git a/judo-ui-react/src/main/resources/actor/src/pages/actions/BulkDeleteAction.fragment.hbs b/judo-ui-react/src/main/resources/actor/src/pages/actions/BulkDeleteAction.fragment.hbs
@@ -27,7 +27,7 @@ const {{ simpleActionDefinitionName action.actionDefinition }} = async (selected
           {{# if page.container.view }}
             {{# with (getRefreshActionDefinitionForContainer page.container) as |refreshActionDefinition| }}
               if (actions.{{ simpleActionDefinitionName refreshActionDefinition }}) {
-                await actions.{{ simpleActionDefinitionName refreshActionDefinition }}!(processQueryCustomizer(pageQueryCustomizer));
+                await actions.{{ simpleActionDefinitionName refreshActionDefinition }}!(processQueryCustomizer(getPageQueryCustomizer()));
               }
             {{/ with }}
           {{/ if }}

diff --git a/judo-ui-react/src/main/resources/actor/src/pages/actions/BulkRemoveAction.fragment.hbs b/judo-ui-react/src/main/resources/actor/src/pages/actions/BulkRemoveAction.fragment.hbs
@@ -36,7 +36,7 @@ const {{ simpleActionDefinitionName action.actionDefinition }} = async (selected
             {{# if page.container.view }}
               {{# with (getRefreshActionDefinitionForContainer page.container) as |refreshActionDefinition| }}
                 if (actions.{{ simpleActionDefinitionName refreshActionDefinition }}) {
-                  await actions.{{ simpleActionDefinitionName refreshActionDefinition }}!(processQueryCustomizer(pageQueryCustomizer));
+                  await actions.{{ simpleActionDefinitionName refreshActionDefinition }}!(processQueryCustomizer(getPageQueryCustomizer()));
                 }
               {{/ with }}
             {{/ if }}

diff --git a/judo-ui-react/src/main/resources/actor/src/pages/actions/CallOperationAction.fragment.hbs b/judo-ui-react/src/main/resources/actor/src/pages/actions/CallOperationAction.fragment.hbs
@@ -52,7 +52,7 @@ const {{ simpleActionDefinitionName action.actionDefinition }} = async ({{# if a
       {{# if page.container.view }}
         if (!editMode) {
           {{# with (getRefreshActionDefinitionForContainer page.container) as |actionDefinition| }}
-            await actions.{{ simpleActionDefinitionName actionDefinition }}!(processQueryCustomizer(pageQueryCustomizer));
+            await actions.{{ simpleActionDefinitionName actionDefinition }}!(processQueryCustomizer(getPageQueryCustomizer()));
           {{/ with }}
         }
       {{/ if }}

diff --git a/judo-ui-react/src/main/resources/actor/src/pages/actions/CancelAction.fragment.hbs b/judo-ui-react/src/main/resources/actor/src/pages/actions/CancelAction.fragment.hbs
@@ -1,6 +1,6 @@
 const {{ simpleActionDefinitionName action.actionDefinition }} = async () => {
   {{# with (getRefreshActionDefinitionForContainer page.container) as |actionDefinition| }}
     // no need to set editMode to false, given refresh should do it implicitly
-    await {{ simpleActionDefinitionName actionDefinition }}(processQueryCustomizer(pageQueryCustomizer));
+    await {{ simpleActionDefinitionName actionDefinition }}(processQueryCustomizer(getPageQueryCustomizer()));
   {{/ with }}
 };
diff --git a/judo-ui-react/src/main/resources/actor/src/pages/actions/ClearAction.fragment.hbs b/judo-ui-react/src/main/resources/actor/src/pages/actions/ClearAction.fragment.hbs
@@ -11,7 +11,7 @@ const {{ simpleActionDefinitionName action.actionDefinition }} = async () => {
         {{# if page.container.view }}
           if (!editMode) {
             {{# with (getRefreshActionDefinitionForContainer page.container) as |actionDefinition| }}
-              await actions.{{ simpleActionDefinitionName actionDefinition }}!(processQueryCustomizer(pageQueryCustomizer));
+              await actions.{{ simpleActionDefinitionName actionDefinition }}!(processQueryCustomizer(getPageQueryCustomizer()));
             {{/ with }}
           }
         {{/ if }}

diff --git a/judo-ui-react/src/main/resources/actor/src/pages/actions/DeleteAction.fragment.hbs b/judo-ui-react/src/main/resources/actor/src/pages/actions/DeleteAction.fragment.hbs
@@ -24,7 +24,7 @@ const {{ simpleActionDefinitionName action.actionDefinition }} = async ({{# if a
         {{ else }}
           {{# if (containerIsRefreshable page.container) }}
             {{# with (getRefreshActionDefinitionForContainer page.container) as |refreshActionDefinition| }}
-              {{ simpleActionDefinitionName refreshActionDefinition }}(pageQueryCustomizer);
+              {{ simpleActionDefinitionName refreshActionDefinition }}(getPageQueryCustomizer());
             {{/ with }}
           {{/ if }}
         {{/ unless }}

diff --git a/judo-ui-react/src/main/resources/actor/src/pages/actions/OpenAddSelectorAction.fragment.hbs b/judo-ui-react/src/main/resources/actor/src/pages/actions/OpenAddSelectorAction.fragment.hbs
@@ -26,7 +26,7 @@ const {{ simpleActionDefinitionName action.actionDefinition }} = async () => {
             {{# if page.container.view }}
               if (!editMode) {
                 {{# with (getRefreshActionDefinitionForContainer page.container) as |actionDefinition| }}
-                  await actions.{{ simpleActionDefinitionName actionDefinition }}!(processQueryCustomizer(pageQueryCustomizer));
+                  await actions.{{ simpleActionDefinitionName actionDefinition }}!(processQueryCustomizer(getPageQueryCustomizer()));
                 {{/ with }}
               }
             {{/ if }}

diff --git a/judo-ui-react/src/main/resources/actor/src/pages/actions/OpenFormAction.fragment.hbs b/judo-ui-react/src/main/resources/actor/src/pages/actions/OpenFormAction.fragment.hbs
@@ -3,7 +3,7 @@ const {{ simpleActionDefinitionName action.actionDefinition }} = async ({{# if a
   {{# with (getRefreshActionDefinitionForContainer page.container) as |actionDefinition| }}
     {{# if page.container.view }}
       if (result === 'submit' && !editMode) {
-        await actions.{{ simpleActionDefinitionName actionDefinition }}!(processQueryCustomizer(pageQueryCustomizer));
+        await actions.{{ simpleActionDefinitionName actionDefinition }}!(processQueryCustomizer(getPageQueryCustomizer()));
       }
     {{/ if }}
     {{# if page.container.table }}

diff --git a/.../src/main/resources/actor/src/pages/actions/OpenOperationInputSelectorAction.fragment.hbs b/.../src/main/resources/actor/src/pages/actions/OpenOperationInputSelectorAction.fragment.hbs
@@ -4,7 +4,7 @@ const {{ simpleActionDefinitionName action.actionDefinition }} = async () => {
     {{# if page.container.view }}
       if (!editMode) {
         {{# with (getRefreshActionDefinitionForContainer page.container) as |actionDefinition| }}
-          await actions.{{ simpleActionDefinitionName actionDefinition }}!(processQueryCustomizer(pageQueryCustomizer));
+          await actions.{{ simpleActionDefinitionName actionDefinition }}!(processQueryCustomizer(getPageQueryCustomizer()));
         {{/ with }}
       }
     {{/ if }}

diff --git a/judo-ui-react/src/main/resources/actor/src/pages/actions/OpenPageAction.fragment.hbs b/judo-ui-react/src/main/resources/actor/src/pages/actions/OpenPageAction.fragment.hbs
@@ -4,7 +4,7 @@ const {{ simpleActionDefinitionName action.actionDefinition }} = async (target?:
     {{# with (getRefreshActionDefinitionForContainer page.container) as |actionDefinition| }}
       {{# if page.container.view }}
         if (!editMode) {
-          await actions.{{ simpleActionDefinitionName actionDefinition }}!(processQueryCustomizer(pageQueryCustomizer));
+          await actions.{{ simpleActionDefinitionName actionDefinition }}!(processQueryCustomizer(getPageQueryCustomizer()));
         }
       {{/ if }}
       {{# if page.container.table }}

diff --git a/judo-ui-react/src/main/resources/actor/src/pages/actions/RefreshAction.fragment.hbs b/judo-ui-react/src/main/resources/actor/src/pages/actions/RefreshAction.fragment.hbs
@@ -10,7 +10,7 @@ const {{ simpleActionDefinitionName action.actionDefinition }} = async (queryCus
     {{# if page.container.table }}
       return {{ getServiceImplForPage page }}.list({{# if (pageHasSignedId page) }}{{# if page.openInDialog }}data{{ else }}{ __signedIdentifier: signedIdentifier } as JudoIdentifiable<any>{{/ if }}{{ else }}undefined{{/ if }}, queryCustomizer);
     {{ else }}
-      const result = await {{ getServiceImplForPage page }}.refresh({{{ refreshActionDataParameter action }}}, pageQueryCustomizer);
+      const result = await {{ getServiceImplForPage page }}.refresh({{{ refreshActionDataParameter action }}}, getPageQueryCustomizer());
       setData(result);
       setLatestViewData(result);
       // re-set payloadDiff

diff --git a/judo-ui-react/src/main/resources/actor/src/pages/actions/RemoveAction.fragment.hbs b/judo-ui-react/src/main/resources/actor/src/pages/actions/RemoveAction.fragment.hbs
@@ -17,7 +17,7 @@ const {{ simpleActionDefinitionName action.actionDefinition }} = async (target?:
             {{# if page.container.view }}
               if (!editMode) {
                 {{# with (getRefreshActionDefinitionForContainer page.container) as |actionDefinition| }}
-                  await actions.{{ simpleActionDefinitionName actionDefinition }}!(processQueryCustomizer(pageQueryCustomizer));
+                  await actions.{{ simpleActionDefinitionName actionDefinition }}!(processQueryCustomizer(getPageQueryCustomizer()));
                 {{/ with }}
               }
             {{/ if }}

diff --git a/judo-ui-react/src/main/resources/actor/src/pages/actions/UpdateAction.fragment.hbs b/judo-ui-react/src/main/resources/actor/src/pages/actions/UpdateAction.fragment.hbs
@@ -9,7 +9,7 @@ const {{ simpleActionDefinitionName action.actionDefinition }} = async () => {
       showSuccessSnack(t('judo.action.save.success', { defaultValue: 'Changes saved' }));
       setValidation(new Map<keyof {{ classDataName (getReferenceClassType page) '' }}, string>());
       {{# with (getRefreshActionDefinitionForContainer page.container) as |actionDefinition| }}
-      await actions.{{ simpleActionDefinitionName actionDefinition }}!(pageQueryCustomizer);
+      await actions.{{ simpleActionDefinitionName actionDefinition }}!(getPageQueryCustomizer());
       {{/ with }}
       setEditMode(false);
     }

diff --git a/judo-ui-react/src/main/resources/actor/src/pages/index.tsx.hbs b/judo-ui-react/src/main/resources/actor/src/pages/index.tsx.hbs
@@ -151,9 +151,9 @@ export default function {{ pageName page }}() {
       }, [data]);
 
       {{# if page.container.view }}
-        const pageQueryCustomizer: {{ classDataName (getReferenceClassType page) 'QueryCustomizer' }} = {
-          _mask: '{{ getMaskForView page.container }}',
-        };
+        const getPageQueryCustomizer: () => {{ classDataName (getReferenceClassType page) 'QueryCustomizer' }} = () => ({
+          _mask: actions.getMask ? actions.getMask!() : '{{ getMaskForView page.container }}',
+        });
       {{/ if }}
     {{/ unless }}
 
@@ -177,7 +177,7 @@ export default function {{ pageName page }}() {
         {{# if page.container.view }}
           {{# with (getRefreshActionDefinitionForContainer page.container) as |refreshActionDefinition| }}
             if (actions.{{ simpleActionDefinitionName refreshActionDefinition }}) {
-              await actions.{{ simpleActionDefinitionName refreshActionDefinition }}!(processQueryCustomizer(pageQueryCustomizer));
+              await actions.{{ simpleActionDefinitionName refreshActionDefinition }}!(processQueryCustomizer(getPageQueryCustomizer()));
             }
           {{/ with }}
         {{/ if }}
@@ -265,7 +265,7 @@ export default function {{ pageName page }}() {
               return;
             }
           {{/ if }}
-          await actions.{{ simpleActionDefinitionName page.container.onInit }}!({{# if page.container.view }}pageQueryCustomizer{{/ if }});
+          await actions.{{ simpleActionDefinitionName page.container.onInit }}!({{# if page.container.view }}getPageQueryCustomizer(){{/ if }});
         })();
       }, []);
     {{/ if }}