feat: Added submit payload augmenters

Author: pksorensen

packages/core/src/state/QuickFormContext.tsx

@@ -16,6 +16,8 @@ interface IQuickFormContext {
     isFirstQuestionInCurrentSlide: (questionLogicalName: string) => boolean;
     getCurrentSlide: () => SlideModel;
     onSubmitAsync?: (formdata: any) => Promise<string>;
+    addPayloadAugmenter: (augmenter: (payload: any) => any) => void;
+    removePayloadAugmenter: (augmenter: (payload: any) => any) => void;
     cssVariables: { [key: string]: string };
 }
 
@@ -34,6 +36,8 @@ export const QuickFormContext = React.createContext<IQuickFormContext>(
             { questions: [], rows: [], isAnswered: false, addQuestion: () => ({ type: "question", ref: "" }) }
         ),
         onSubmitAsync: async (formdata) => { return "" },
+        addPayloadAugmenter: () => { },
+        removePayloadAugmenter: () => { },
         cssVariables: {}
     }
 );

packages/core/src/state/QuickformAction.ts

@@ -15,4 +15,7 @@ export type QuickformAction =
     | { type: 'SET_SUBMIT_STATUS', status: SubmitStatus }
     | { type: 'SUBMIT', dispatch: React.Dispatch<QuickformAction>, id: string }
     | { type: 'SET_INTRO_VISITED' }
-    | { type: 'GO_TO_ENDING' };
+    | { type: 'GO_TO_ENDING' }
+    | { type: 'ADD_PAYLOAD_AUGMENTER', augmenter }
+    | { type: 'REMOVE_PAYLOAD_AUGMENTER', augmenter }
+    ;

packages/core/src/state/QuickformProvider.tsx

@@ -55,6 +55,13 @@ export const QuickFormProvider: React.FC<QuickFormProviderProps> = (
     const isFirstQuestionInCurrentSlide = (questionLogicalName: string) => { return isFirstQInCurrentSlide(questionLogicalName, state); }
     const getCurrentSlide = () => (state.slides[state.currIdx]);
 
+    const addPayloadAugmenter = (augmenter: (payload: any) => any) => {
+        dispatch({ type: 'ADD_PAYLOAD_AUGMENTER', augmenter })
+    }
+    const removePayloadAugmenter = (augmenter: (payload: any) => any) => {
+        dispatch({ type: 'REMOVE_PAYLOAD_AUGMENTER', augmenter })
+    }
+
     return (
         <QuickFormContext.Provider value={{
             state,
@@ -68,7 +75,9 @@ export const QuickFormProvider: React.FC<QuickFormProviderProps> = (
             isFirstQuestionInCurrentSlide,
             getCurrentSlide,
             onSubmitAsync,
-            cssVariables
+            cssVariables,
+            removePayloadAugmenter,
+            addPayloadAugmenter
         }}>
 
             {asContainer ? (

packages/core/src/state/QuickformReducer.ts

@@ -20,6 +20,15 @@ export const quickformReducer = (state: QuickformState, action: QuickformAction)
 
     switch (action.type) {
 
+        case 'ADD_PAYLOAD_AUGMENTER': {
+            state.payloadAugments = [...state.payloadAugments, action.augmenter];
+            return state;
+        }
+        case 'REMOVE_PAYLOAD_AUGMENTER': {
+            state.payloadAugments = state.payloadAugments.filter(augmenter => augmenter !== action.augmenter);
+            return state;
+        }
+
         case 'ANSWER_QUESTION': {
 
             if (span) {

packages/core/src/state/QuickformState.ts

@@ -20,7 +20,8 @@ export type QuickformState = {
     slides: SlideModel[];
     submitStatus: SubmitStatus;
     totalSteps: number;
-    classes: Partial<QuickformClassNames>
+    classes: Partial<QuickformClassNames>,
+    payloadAugments: Array<(payload: any) => any>
 }
 
 export const defaultState = (data: QuickFormModel = defaultData, layout?: LayoutDefinition): QuickformState => {
@@ -42,6 +43,7 @@ export const defaultState = (data: QuickFormModel = defaultData, layout?: Layout
         slides: data.slides,
         submitStatus: { isSubmitting: false, isSubmitError: false, isSubmitSuccess: false },
         totalSteps: data.slides.length,
+        payloadAugments:[]
     };
 
     return defState;

packages/core/src/state/action-handlers/SubmitActionHandler.ts

@@ -42,7 +42,7 @@ export class SubmitActionHandler {
     static generatePayload = (state: QuickformState): Record<string, any> => {
 
         const logger = resolveQuickFormService("logger");
-        const payload: Record<string, any> = {};
+        let payload: Record<string, any> = {};
         for (var slide of state.slides) {
             slide.questions.forEach(q => {
                 payload[q.logicalName!] = q.output;
@@ -63,6 +63,9 @@ export class SubmitActionHandler {
 
             payload["submitFields"][q.logicalName] = value;
         }
+        for (let augmenter of state.payloadAugments) {
+            payload = augmenter(payload);
+        }
 
         return payload;
     }