@beinformed/ui 1.27.0 → 1.27.2

package/src/models/attributes/AttributeDataHelper.js

@@ -1,5 +1,5 @@
 // @flow
-import cloneDeep from "lodash/cloneDeep";
+import { klona } from "klona/full";
 import pick from "lodash/pick";
 
 import { has, isPlainObject } from "../../utils/helpers/objects";
@@ -33,7 +33,7 @@ class AttributeDataHelper {
         ) || {};
       this._value = this.getValue(this._attribute);
     } else {
-      const attributeData = cloneDeep(data);
+      const attributeData = klona(data);
       attributeData._links = pick(data._links, [
         "concept",
         "download",

package/src/models/attributes/CaptchaAttributeModel.js

@@ -5,6 +5,8 @@ import AttributeModel from "./AttributeModel";
  * Password attribute
  */
 export default class CaptchaAttributeModel extends AttributeModel {
+  _answer: string = "";
+
   /**
    */
   static isApplicableModel(contributions: Object): boolean {
@@ -27,6 +29,20 @@ export default class CaptchaAttributeModel extends AttributeModel {
     return this;
   }
 
+  /**
+   */
+  setAnswer(answer: string) {
+    this._answer = answer;
+  }
+
+  /**
+   * Retrieve the given answer for the captcha
+   * The value of this attribute is the token id of the captcha
+   */
+  getAnswer(): string {
+    return this._answer;
+  }
+
   /**
    */
   get hasDynamicValidationData(): boolean {

package/src/models/attributes/__tests__/ChoiceAttributeModel.spec.js

@@ -130,6 +130,9 @@ describe("choiceAttributeModel", () => {
     expect(attribute.format).toBeNull();
 
     expect(attribute.options).toHaveLength(4);
+
+    const clonedAttribute = attribute.clone();
+    expect(clonedAttribute).toStrictEqual(attribute);
   });
 
   it("handles sort-options hint", () => {

package/src/models/attributes/__tests__/CompositeAttributeModel.spec.js

@@ -202,6 +202,9 @@ describe("compositeAttributeModel", () => {
       PrintingHouse: "Printers united",
       Title: "Matilda",
     });
+
+    const clonedAttribute = attribute.clone();
+    expect(clonedAttribute).toStrictEqual(attribute);
   });
 
   it("creates a composite attribute for a choice attribute with a table codemap on a list, multiple choice", () => {

package/src/models/attributes/_createAttribute.js

@@ -1,5 +1,5 @@
 // @flow
-import cloneDeep from "lodash/cloneDeep";
+import { klona } from "klona/full";
 
 import { has, isPlainObject } from "../../utils/helpers/objects";
 
@@ -105,7 +105,7 @@ const updateData = (
   data: Object,
   contributions: Object
 ): Object => {
-  const newData = cloneDeep(data);
+  const newData = klona(data);
 
   if (contributions.dynamicschemaId) {
     newData.dynamicschemaId = contributions.dynamicschemaId;

package/src/models/base/BaseCollection.js

@@ -1,6 +1,5 @@
 // @flow
-import clone from "lodash/clone";
-import cloneDeep from "lodash/cloneDeep";
+import { klona } from "klona/full";
 
 /**
  * Base class for collections of models
@@ -182,15 +181,10 @@ class BaseCollection<T> {
   }
 
   /**
-   * Returns a clone of the model (this is not a deep copy)
+   * Returns a clone of the model
    */
-  clone(deepcopy: boolean = false): this {
-    // deepcopy can be expensive, use with care!
-    if (deepcopy) {
-      return cloneDeep(this);
-    }
-
-    return clone(this);
+  clone(): this {
+    return klona(this);
   }
 }
 

package/src/models/base/BaseModel.js

@@ -1,6 +1,5 @@
 // @flow
-import clone from "lodash/clone";
-import cloneDeep from "lodash/cloneDeep";
+import { klona } from "klona/full";
 
 import LayoutHintCollection from "../layouthint/LayoutHintCollection";
 
@@ -118,13 +117,8 @@ class BaseModel {
   /**
    * Returns a clone of the model
    */
-  clone(deepcopy: boolean = false): any {
-    // deepcopy can be expensive, use with care!
-    if (deepcopy) {
-      return cloneDeep(this);
-    }
-
-    return clone(this);
+  clone(): any {
+    return klona(this);
   }
 }
 

package/src/models/base/__tests__/BaseModel.spec.js

@@ -11,7 +11,8 @@ describe("baseModel", () => {
     expect(model.contributions).toStrictEqual({});
     expect(model.hasData).toBeFalsy();
 
-    expect(model.clone()).toStrictEqual(model);
+    const clonedModel = model.clone();
+    expect(clonedModel).toStrictEqual(model);
   });
 
   it("should handle data without contributions", () => {
@@ -72,12 +73,7 @@ describe("baseModel", () => {
       },
     });
 
-    const shallowClone = model.clone();
-    expect(model).not.toBe(shallowClone);
-    expect(model.data.prop).toBe(shallowClone.data.prop);
-    expect(model.data.prop.child).toBe(shallowClone.data.prop.child);
-
-    const deepClone = model.clone(true);
+    const deepClone = model.clone();
     expect(model).not.toBe(deepClone);
     expect(model.data.prop === deepClone.data.prop).toBeFalsy();
     expect(model.data.prop.child).toBe(deepClone.data.prop.child);

package/src/modularui/CaptchaRequest.js

@@ -2,30 +2,65 @@
 import xhr from "../utils/fetch/xhr";
 import { getCaptchaPath, HTTP_METHODS } from "../constants";
 
+type CaptchaInitialResponse = {
+  tokenId: string,
+  image: string,
+};
+
+type CaptchaValidResponse = {
+  valid: boolean,
+};
+
+type CaptchaInvalidResponse = {
+  tokenId: string,
+  image: string,
+  valid: boolean,
+  error: { id: string },
+};
+
 type CaptchaResponse = {
   tokenId: string,
-  image: any,
+  image: string,
   valid: boolean,
+  error: { id: string } | null,
 };
 
 /**
  */
 class CaptchaRequest {
   _tokenId: string;
+  _image: string;
 
   /**
    */
+  captchaResponse(
+    response:
+      | CaptchaInitialResponse
+      | CaptchaValidResponse
+      | CaptchaInvalidResponse
+  ): CaptchaResponse {
+    this._tokenId = response.tokenId ?? this._tokenId;
+    this._image = response.image ?? this._image;
+
+    return {
+      tokenId: this._tokenId,
+      image: this._image,
+      valid: response.valid ?? false,
+      error: response.error ?? null,
+    };
+  }
+
+  /**
+   * Initiate the captcha request
+   */
   init(): Promise<CaptchaResponse> {
     return xhr({
       url: getCaptchaPath(),
-    }).then((response) => {
-      this._tokenId = response.tokenId;
-
-      return response;
-    });
+    }).then((response) => this.captchaResponse(response));
   }
 
   /**
+   * Answer the captcha
    */
   send(answer?: string): Promise<CaptchaResponse> {
     return xhr({
@@ -35,10 +70,16 @@ class CaptchaRequest {
         tokenId: this._tokenId ?? "",
         answer: answer ?? "",
       },
-    }).catch((error) => {
-      this._tokenId = error.response.tokenId;
-      return error.response;
-    });
+    })
+      .then((response) => this.captchaResponse(response))
+      .catch((error) => this.captchaResponse(error.response));
+  }
+
+  /**
+   * Reset the captcha and receive a new token and image
+   */
+  refresh(): Promise<CaptchaResponse> {
+    return this.init();
   }
 }
 

package/src/redux/actions/FormValidations.js

@@ -25,7 +25,7 @@ const updateValidations =
     const currentForm = getState().modularui[form.connectKey];
 
     if (currentForm) {
-      const validatedForm = currentForm.model.clone(true);
+      const validatedForm = currentForm.model.clone();
       if (validatedForm instanceof FormModel) {
         validatedForm.updateValidations(formWithValidations.data);
       }

package/types/models/attributes/CaptchaAttributeModel.d.ts

@@ -2,9 +2,18 @@
  * Password attribute
  */
 export default class CaptchaAttributeModel extends AttributeModel {
+    _answer: string;
     /**
      * Update the attribute by name and value
      */
     update(value: string): this;
+    /**
+     */
+    setAnswer(answer: string): void;
+    /**
+     * Retrieve the given answer for the captcha
+     * The value of this attribute is the token id of the captcha
+     */
+    getAnswer(): string;
 }
 import AttributeModel from "./AttributeModel";

package/types/models/base/BaseCollection.d.ts

@@ -83,7 +83,7 @@ declare class BaseCollection<T> {
      */
     get sorted(): T[];
     /**
-     * Returns a clone of the model (this is not a deep copy)
+     * Returns a clone of the model
      */
-    clone(deepcopy?: boolean): this;
+    clone(): this;
 }

package/types/models/base/BaseModel.d.ts

@@ -62,6 +62,6 @@ declare class BaseModel {
     /**
      * Returns a clone of the model
      */
-    clone(deepcopy?: boolean): any;
+    clone(): any;
 }
 import LayoutHintCollection from "../layouthint/LayoutHintCollection";

package/types/modularui/CaptchaRequest.d.ts

@@ -3,15 +3,43 @@ export default CaptchaRequest;
  */
 declare class CaptchaRequest {
     _tokenId: string;
+    _image: string;
     /**
      */
+    captchaResponse(response: CaptchaInitialResponse | CaptchaValidResponse | CaptchaInvalidResponse): CaptchaResponse;
+    /**
+     * Initiate the captcha request
+     */
     init(): Promise<CaptchaResponse>;
     /**
+     * Answer the captcha
      */
     send(answer?: string): Promise<CaptchaResponse>;
+    /**
+     * Reset the captcha and receive a new token and image
+     */
+    refresh(): Promise<CaptchaResponse>;
 }
+type CaptchaInitialResponse = {
+    tokenId: string;
+    image: string;
+};
+type CaptchaValidResponse = {
+    valid: boolean;
+};
+type CaptchaInvalidResponse = {
+    tokenId: string;
+    image: string;
+    valid: boolean;
+    error: {
+        id: string;
+    };
+};
 type CaptchaResponse = {
     tokenId: string;
-    image: any;
+    image: string;
     valid: boolean;
+    error: {
+        id: string;
+    };
 };