@beinformed/ui 1.30.0 → 1.30.1

package/src/models/form/FormModel.js

@@ -51,6 +51,7 @@ class FormModel extends ResourceModel {
   _commit: boolean;
   _isFinished: boolean;
   _isComplete: boolean;
+  _success: { redirect: string, data: Object } | null;
 
   _parameters: Array<Parameter>;
   _tokens: Array<string>;
@@ -72,6 +73,8 @@ class FormModel extends ResourceModel {
     if (this.data.errors) {
       this.handleRootErrors(this.data.errors);
     }
+
+    this.createSuccess();
   }
 
   /**
@@ -574,7 +577,7 @@ class FormModel extends ResourceModel {
    * Inidicates if form is finished: Form is completely entered and committed
    */
   get isFinished(): boolean {
-    return this._isFinished || "success" in this.data;
+    return this._isFinished || this.success != undefined;
   }
 
   /**
@@ -600,8 +603,8 @@ class FormModel extends ResourceModel {
    * Handle success redirects
    */
   get successRedirect(): Href | null {
-    return this.isFinished && this.data.success
-      ? new Href(this.data.success.redirect)
+    return this.isFinished && this.success
+      ? new Href(this.success.redirect)
       : null;
   }
 
@@ -615,7 +618,7 @@ class FormModel extends ResourceModel {
    * Get the result data as plain json object
    */
   getSuccessData(): ?Object {
-    return this.data.success?.data;
+    return this.success?.data;
   }
 
   /**
@@ -888,6 +891,8 @@ class FormModel extends ResourceModel {
    */
   setPreviousObject() {
     this.isComplete = false;
+    this.isFinished = false;
+    this.success = null;
 
     const oldCurrentFormObject = this.currentFormObject;
 
@@ -985,6 +990,7 @@ class FormModel extends ResourceModel {
 
       this.isComplete = receivedForm.isComplete;
       this.isFinished = receivedForm.isFinished;
+      this.success = receivedForm.success;
 
       const receivedFormData = receivedForm.data ?? {};
       const hasMissing = has(receivedFormData, "missing");
@@ -1016,6 +1022,28 @@ class FormModel extends ResourceModel {
     return this;
   }
 
+  /**
+   * Retrieve success information from response
+   * @returns {{redirect: string, data: object}}
+   */
+  get success(): { redirect: string, data: Object } | null {
+    return this._success;
+  }
+
+  /**
+   * Set success information, contains redirect and event data
+   * @param success
+   */
+  set success(success: { redirect: string, data: Object } | null) {
+    this._success = success;
+  }
+
+  /**
+   */
+  createSuccess() {
+    this._success = this.data.success;
+  }
+
   /**
    * Process finished form
    */

package/src/models/form/__tests__/FormModel.spec.js

@@ -458,11 +458,15 @@ describe("formModel", () => {
     expect(form.completedFormObjects).toHaveLength(2);
     expect(form.allObjects).toHaveLength(2);
     expect(form.currentFormObject).toBeNull();
+    expect(form.success).toStrictEqual({ redirect: "/endredirect" });
+    expect(form.isFinished).toBe(true);
 
     form.setPreviousObject();
     expect(form.completedFormObjects).toHaveLength(1);
     expect(form.currentFormObject).toBeInstanceOf(FormObjectModel);
     expect(form.hasNextStep).toBeFalsy();
+    expect(form.success).toBeNull();
+    expect(form.isFinished).toBe(false);
   });
 
   it("is able to get formdata for request", () => {

package/types/models/form/FormModel.d.ts

@@ -15,6 +15,10 @@ declare class FormModel extends ResourceModel {
     _commit: boolean;
     _isFinished: boolean;
     _isComplete: boolean;
+    _success: {
+        redirect: string;
+        data: Object;
+    } | null;
     _parameters: Array<Parameter>;
     _tokens: Array<string>;
     /**
@@ -252,6 +256,22 @@ declare class FormModel extends ResourceModel {
      * a different key than the current form object
      */
     setPreviousObject(): void;
+    /**
+     * Set success information, contains redirect and event data
+     * @param success
+     */
+    set success(arg: {
+        redirect: string;
+        data: Object;
+    });
+    /**
+     * Retrieve success information from response
+     * @returns {{redirect: string, data: object}}
+     */
+    get success(): {
+        redirect: string;
+        data: Object;
+    };
     /**
      * Form navigation: has next step or is last
      */
@@ -264,6 +284,9 @@ declare class FormModel extends ResourceModel {
     /**
      */
     updateValidations(data: any): FormModel;
+    /**
+     */
+    createSuccess(): void;
     /**
      * Process finished form
      */

package/types/models/index.d.ts

@@ -89,6 +89,7 @@ import { default as AssignmentFilterModel } from "./filters/AssignmentFilterMode
 import { default as FilterModel } from "./filters/FilterModel";
 import { default as RangeFilterModel } from "./filters/RangeFilterModel";
 import { default as ConceptIndexFilterModel } from "./filters/ConceptIndexFilterModel";
-export { ApplicationModel, CaseSearchModel, CaseViewModel, ListDetailModel, DetailModel, FormModel, GroupingPanelModel, ListModel, TabModel, TaskGroupModel, UserModel, UserProfileModel, UserServicesModel, ModelCatalogModel, ConceptIndexModel, ConceptDetailModel, BusinessScenarioModel, ConceptTypeDetailModel, ContentIndexModel, ContentTOCModel, ContentModel, ContentTypeModel, BooleanAttributeModel, CaptchaAttributeModel, ChoiceAttributeModel, DatetimeAttributeModel, HelptextAttributeModel, LabelAttributeModel, MemoAttributeModel, MoneyAttributeModel, NumberAttributeModel, PasswordAttributeModel, CompositeAttributeModel, StringAttributeModel, UploadAttributeModel, XMLAttributeModel, AssignmentFilterModel, FilterModel, RangeFilterModel, ConceptIndexFilterModel };
+import { default as LayoutHintCollection } from "./layouthint/LayoutHintCollection";
+export { ApplicationModel, CaseSearchModel, CaseViewModel, ListDetailModel, DetailModel, FormModel, GroupingPanelModel, ListModel, TabModel, TaskGroupModel, UserModel, UserProfileModel, UserServicesModel, ModelCatalogModel, ConceptIndexModel, ConceptDetailModel, BusinessScenarioModel, ConceptTypeDetailModel, ContentIndexModel, ContentTOCModel, ContentModel, ContentTypeModel, BooleanAttributeModel, CaptchaAttributeModel, ChoiceAttributeModel, DatetimeAttributeModel, HelptextAttributeModel, LabelAttributeModel, MemoAttributeModel, MoneyAttributeModel, NumberAttributeModel, PasswordAttributeModel, CompositeAttributeModel, StringAttributeModel, UploadAttributeModel, XMLAttributeModel, AssignmentFilterModel, FilterModel, RangeFilterModel, ConceptIndexFilterModel, LayoutHintCollection };
 export { default as LayoutHintRuleCollection, addLayoutHintRule, updateLayoutHintRules } from "./attributes/layouthint-rules/LayoutHintRuleCollection";
 export { default as GroupingModel, GroupModel } from "./grouping/GroupingModel";