@beinformed/ui 1.27.0 → 1.27.1

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.27.1](https://git.beinformed.com/public/nl.beinformed.bi.layout.lib.ui/compare/v1.27.0...v1.27.1) (2023-01-24)
+
+### Bug Fixes
+
+- **captcha:** improve usage of captcha request ([b880306](https://git.beinformed.com/public/nl.beinformed.bi.layout.lib.ui/commit/b8803067cecb90c940dc8aab824615357efdf37c))
+
 ## [1.27.0](https://git.beinformed.com/public/nl.beinformed.bi.layout.lib.ui/compare/v1.27.0-beta.1...v1.27.0) (2023-01-20)
 
 ## [1.27.0-beta.1](https://git.beinformed.com/public/nl.beinformed.bi.layout.lib.ui/compare/v1.27.0-beta.0...v1.27.0-beta.1) (2023-01-20)

package/esm/models/attributes/CaptchaAttributeModel.js

@@ -1,9 +1,14 @@
+import _defineProperty from "@babel/runtime-corejs3/helpers/esm/defineProperty";
 import AttributeModel from "./AttributeModel";
 
 /**
  * Password attribute
  */
 export default class CaptchaAttributeModel extends AttributeModel {
+  constructor() {
+    super(...arguments);
+    _defineProperty(this, "_answer", "");
+  }
   /**
    */
   static isApplicableModel(contributions) {
@@ -25,6 +30,20 @@ export default class CaptchaAttributeModel extends AttributeModel {
     return this;
   }
 
+  /**
+   */
+  setAnswer(answer) {
+    this._answer = answer;
+  }
+
+  /**
+   * Retrieve the given answer for the captcha
+   * The value of this attribute is the token id of the captcha
+   */
+  getAnswer() {
+    return this._answer;
+  }
+
   /**
    */
   get hasDynamicValidationData() {

package/esm/models/attributes/CaptchaAttributeModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"CaptchaAttributeModel.js","names":["AttributeModel","CaptchaAttributeModel","isApplicableModel","contributions","type","update","value","updateLastModification","inputvalue","hasDynamicValidationData"],"sources":["../../../src/models/attributes/CaptchaAttributeModel.js"],"sourcesContent":["// @flow\nimport AttributeModel from \"./AttributeModel\";\n\n/**\n * Password attribute\n */\nexport default class CaptchaAttributeModel extends AttributeModel {\n  /**\n   */\n  static isApplicableModel(contributions: Object): boolean {\n    return contributions.type === \"captcha\";\n  }\n\n  /**\n   */\n  get type(): string {\n    return \"captcha\";\n  }\n\n  /**\n   * Update the attribute by name and value\n   */\n  update(value: string): this {\n    this.updateLastModification();\n    this.inputvalue = value;\n\n    return this;\n  }\n\n  /**\n   */\n  get hasDynamicValidationData(): boolean {\n    return false;\n  }\n}\n"],"mappings":"AACA,OAAOA,cAAc,MAAM,kBAAkB;;AAE7C;AACA;AACA;AACA,eAAe,MAAMC,qBAAqB,SAASD,cAAc,CAAC;EAChE;AACF;EACE,OAAOE,iBAAiB,CAACC,aAAqB,EAAW;IACvD,OAAOA,aAAa,CAACC,IAAI,KAAK,SAAS;EACzC;;EAEA;AACF;EACE,IAAIA,IAAI,GAAW;IACjB,OAAO,SAAS;EAClB;;EAEA;AACF;AACA;EACEC,MAAM,CAACC,KAAa,EAAQ;IAC1B,IAAI,CAACC,sBAAsB,EAAE;IAC7B,IAAI,CAACC,UAAU,GAAGF,KAAK;IAEvB,OAAO,IAAI;EACb;;EAEA;AACF;EACE,IAAIG,wBAAwB,GAAY;IACtC,OAAO,KAAK;EACd;AACF"}
+{"version":3,"file":"CaptchaAttributeModel.js","names":["AttributeModel","CaptchaAttributeModel","isApplicableModel","contributions","type","update","value","updateLastModification","inputvalue","setAnswer","answer","_answer","getAnswer","hasDynamicValidationData"],"sources":["../../../src/models/attributes/CaptchaAttributeModel.js"],"sourcesContent":["// @flow\nimport AttributeModel from \"./AttributeModel\";\n\n/**\n * Password attribute\n */\nexport default class CaptchaAttributeModel extends AttributeModel {\n  _answer: string = \"\";\n\n  /**\n   */\n  static isApplicableModel(contributions: Object): boolean {\n    return contributions.type === \"captcha\";\n  }\n\n  /**\n   */\n  get type(): string {\n    return \"captcha\";\n  }\n\n  /**\n   * Update the attribute by name and value\n   */\n  update(value: string): this {\n    this.updateLastModification();\n    this.inputvalue = value;\n\n    return this;\n  }\n\n  /**\n   */\n  setAnswer(answer: string) {\n    this._answer = answer;\n  }\n\n  /**\n   * Retrieve the given answer for the captcha\n   * The value of this attribute is the token id of the captcha\n   */\n  getAnswer(): string {\n    return this._answer;\n  }\n\n  /**\n   */\n  get hasDynamicValidationData(): boolean {\n    return false;\n  }\n}\n"],"mappings":";AACA,OAAOA,cAAc,MAAM,kBAAkB;;AAE7C;AACA;AACA;AACA,eAAe,MAAMC,qBAAqB,SAASD,cAAc,CAAC;EAAA;IAAA;IAAA,iCAC9C,EAAE;EAAA;EAEpB;AACF;EACE,OAAOE,iBAAiB,CAACC,aAAqB,EAAW;IACvD,OAAOA,aAAa,CAACC,IAAI,KAAK,SAAS;EACzC;;EAEA;AACF;EACE,IAAIA,IAAI,GAAW;IACjB,OAAO,SAAS;EAClB;;EAEA;AACF;AACA;EACEC,MAAM,CAACC,KAAa,EAAQ;IAC1B,IAAI,CAACC,sBAAsB,EAAE;IAC7B,IAAI,CAACC,UAAU,GAAGF,KAAK;IAEvB,OAAO,IAAI;EACb;;EAEA;AACF;EACEG,SAAS,CAACC,MAAc,EAAE;IACxB,IAAI,CAACC,OAAO,GAAGD,MAAM;EACvB;;EAEA;AACF;AACA;AACA;EACEE,SAAS,GAAW;IAClB,OAAO,IAAI,CAACD,OAAO;EACrB;;EAEA;AACF;EACE,IAAIE,wBAAwB,GAAY;IACtC,OAAO,KAAK;EACd;AACF"}

package/esm/modularui/CaptchaRequest.js

@@ -6,19 +6,32 @@ import { getCaptchaPath, HTTP_METHODS } from "../constants";
 class CaptchaRequest {
   constructor() {
     _defineProperty(this, "_tokenId", void 0);
+    _defineProperty(this, "_image", void 0);
   }
   /**
    */
+  captchaResponse(response) {
+    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() {
     return xhr({
       url: getCaptchaPath()
-    }).then(response => {
-      this._tokenId = response.tokenId;
-      return response;
-    });
+    }).then(response => this.captchaResponse(response));
   }
 
   /**
+   * Answer the captcha
    */
   send(answer) {
     return xhr({
@@ -28,10 +41,14 @@ 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() {
+    return this.init();
   }
 }
 export default CaptchaRequest;

package/esm/modularui/CaptchaRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"CaptchaRequest.js","names":["xhr","getCaptchaPath","HTTP_METHODS","CaptchaRequest","init","url","then","response","_tokenId","tokenId","send","answer","method","POST","data","catch","error"],"sources":["../../src/modularui/CaptchaRequest.js"],"sourcesContent":["// @flow\nimport xhr from \"../utils/fetch/xhr\";\nimport { getCaptchaPath, HTTP_METHODS } from \"../constants\";\n\ntype CaptchaResponse = {\n  tokenId: string,\n  image: any,\n  valid: boolean,\n};\n\n/**\n */\nclass CaptchaRequest {\n  _tokenId: string;\n\n  /**\n   */\n  init(): Promise<CaptchaResponse> {\n    return xhr({\n      url: getCaptchaPath(),\n    }).then((response) => {\n      this._tokenId = response.tokenId;\n\n      return response;\n    });\n  }\n\n  /**\n   */\n  send(answer?: string): Promise<CaptchaResponse> {\n    return xhr({\n      url: getCaptchaPath(),\n      method: HTTP_METHODS.POST,\n      data: {\n        tokenId: this._tokenId ?? \"\",\n        answer: answer ?? \"\",\n      },\n    }).catch((error) => {\n      this._tokenId = error.response.tokenId;\n      return error.response;\n    });\n  }\n}\n\nexport default CaptchaRequest;\n"],"mappings":";AACA,OAAOA,GAAG,MAAM,oBAAoB;AACpC,SAASC,cAAc,EAAEC,YAAY,QAAQ,cAAc;AAQ3D;AACA;AACA,MAAMC,cAAc,CAAC;EAAA;IAAA;EAAA;EAGnB;AACF;EACEC,IAAI,GAA6B;IAC/B,OAAOJ,GAAG,CAAC;MACTK,GAAG,EAAEJ,cAAc;IACrB,CAAC,CAAC,CAACK,IAAI,CAAEC,QAAQ,IAAK;MACpB,IAAI,CAACC,QAAQ,GAAGD,QAAQ,CAACE,OAAO;MAEhC,OAAOF,QAAQ;IACjB,CAAC,CAAC;EACJ;;EAEA;AACF;EACEG,IAAI,CAACC,MAAe,EAA4B;IAC9C,OAAOX,GAAG,CAAC;MACTK,GAAG,EAAEJ,cAAc,EAAE;MACrBW,MAAM,EAAEV,YAAY,CAACW,IAAI;MACzBC,IAAI,EAAE;QACJL,OAAO,EAAE,IAAI,CAACD,QAAQ,IAAI,EAAE;QAC5BG,MAAM,EAAEA,MAAM,IAAI;MACpB;IACF,CAAC,CAAC,CAACI,KAAK,CAAEC,KAAK,IAAK;MAClB,IAAI,CAACR,QAAQ,GAAGQ,KAAK,CAACT,QAAQ,CAACE,OAAO;MACtC,OAAOO,KAAK,CAACT,QAAQ;IACvB,CAAC,CAAC;EACJ;AACF;AAEA,eAAeJ,cAAc"}
+{"version":3,"file":"CaptchaRequest.js","names":["xhr","getCaptchaPath","HTTP_METHODS","CaptchaRequest","captchaResponse","response","_tokenId","tokenId","_image","image","valid","error","init","url","then","send","answer","method","POST","data","catch","refresh"],"sources":["../../src/modularui/CaptchaRequest.js"],"sourcesContent":["// @flow\nimport xhr from \"../utils/fetch/xhr\";\nimport { getCaptchaPath, HTTP_METHODS } from \"../constants\";\n\ntype CaptchaInitialResponse = {\n  tokenId: string,\n  image: string,\n};\n\ntype CaptchaValidResponse = {\n  valid: boolean,\n};\n\ntype CaptchaInvalidResponse = {\n  tokenId: string,\n  image: string,\n  valid: boolean,\n  error: { id: string },\n};\n\ntype CaptchaResponse = {\n  tokenId: string,\n  image: string,\n  valid: boolean,\n  error: { id: string } | null,\n};\n\n/**\n */\nclass CaptchaRequest {\n  _tokenId: string;\n  _image: string;\n\n  /**\n   */\n  captchaResponse(\n    response:\n      | CaptchaInitialResponse\n      | CaptchaValidResponse\n      | CaptchaInvalidResponse\n  ): CaptchaResponse {\n    this._tokenId = response.tokenId ?? this._tokenId;\n    this._image = response.image ?? this._image;\n\n    return {\n      tokenId: this._tokenId,\n      image: this._image,\n      valid: response.valid ?? false,\n      error: response.error ?? null,\n    };\n  }\n\n  /**\n   * Initiate the captcha request\n   */\n  init(): Promise<CaptchaResponse> {\n    return xhr({\n      url: getCaptchaPath(),\n    }).then((response) => this.captchaResponse(response));\n  }\n\n  /**\n   * Answer the captcha\n   */\n  send(answer?: string): Promise<CaptchaResponse> {\n    return xhr({\n      url: getCaptchaPath(),\n      method: HTTP_METHODS.POST,\n      data: {\n        tokenId: this._tokenId ?? \"\",\n        answer: answer ?? \"\",\n      },\n    })\n      .then((response) => this.captchaResponse(response))\n      .catch((error) => this.captchaResponse(error.response));\n  }\n\n  /**\n   * Reset the captcha and receive a new token and image\n   */\n  refresh(): Promise<CaptchaResponse> {\n    return this.init();\n  }\n}\n\nexport default CaptchaRequest;\n"],"mappings":";AACA,OAAOA,GAAG,MAAM,oBAAoB;AACpC,SAASC,cAAc,EAAEC,YAAY,QAAQ,cAAc;AAyB3D;AACA;AACA,MAAMC,cAAc,CAAC;EAAA;IAAA;IAAA;EAAA;EAInB;AACF;EACEC,eAAe,CACbC,QAG0B,EACT;IACjB,IAAI,CAACC,QAAQ,GAAGD,QAAQ,CAACE,OAAO,IAAI,IAAI,CAACD,QAAQ;IACjD,IAAI,CAACE,MAAM,GAAGH,QAAQ,CAACI,KAAK,IAAI,IAAI,CAACD,MAAM;IAE3C,OAAO;MACLD,OAAO,EAAE,IAAI,CAACD,QAAQ;MACtBG,KAAK,EAAE,IAAI,CAACD,MAAM;MAClBE,KAAK,EAAEL,QAAQ,CAACK,KAAK,IAAI,KAAK;MAC9BC,KAAK,EAAEN,QAAQ,CAACM,KAAK,IAAI;IAC3B,CAAC;EACH;;EAEA;AACF;AACA;EACEC,IAAI,GAA6B;IAC/B,OAAOZ,GAAG,CAAC;MACTa,GAAG,EAAEZ,cAAc;IACrB,CAAC,CAAC,CAACa,IAAI,CAAET,QAAQ,IAAK,IAAI,CAACD,eAAe,CAACC,QAAQ,CAAC,CAAC;EACvD;;EAEA;AACF;AACA;EACEU,IAAI,CAACC,MAAe,EAA4B;IAC9C,OAAOhB,GAAG,CAAC;MACTa,GAAG,EAAEZ,cAAc,EAAE;MACrBgB,MAAM,EAAEf,YAAY,CAACgB,IAAI;MACzBC,IAAI,EAAE;QACJZ,OAAO,EAAE,IAAI,CAACD,QAAQ,IAAI,EAAE;QAC5BU,MAAM,EAAEA,MAAM,IAAI;MACpB;IACF,CAAC,CAAC,CACCF,IAAI,CAAET,QAAQ,IAAK,IAAI,CAACD,eAAe,CAACC,QAAQ,CAAC,CAAC,CAClDe,KAAK,CAAET,KAAK,IAAK,IAAI,CAACP,eAAe,CAACO,KAAK,CAACN,QAAQ,CAAC,CAAC;EAC3D;;EAEA;AACF;AACA;EACEgB,OAAO,GAA6B;IAClC,OAAO,IAAI,CAACT,IAAI,EAAE;EACpB;AACF;AAEA,eAAeT,cAAc"}

package/lib/models/attributes/CaptchaAttributeModel.js

@@ -5,11 +5,16 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/defineProperty"));
 var _AttributeModel = _interopRequireDefault(require("./AttributeModel"));
 /**
  * Password attribute
  */
 class CaptchaAttributeModel extends _AttributeModel.default {
+  constructor() {
+    super(...arguments);
+    (0, _defineProperty2.default)(this, "_answer", "");
+  }
   /**
    */
   static isApplicableModel(contributions) {
@@ -31,6 +36,20 @@ class CaptchaAttributeModel extends _AttributeModel.default {
     return this;
   }
 
+  /**
+   */
+  setAnswer(answer) {
+    this._answer = answer;
+  }
+
+  /**
+   * Retrieve the given answer for the captcha
+   * The value of this attribute is the token id of the captcha
+   */
+  getAnswer() {
+    return this._answer;
+  }
+
   /**
    */
   get hasDynamicValidationData() {

package/lib/models/attributes/CaptchaAttributeModel.js.flow

@@ -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/lib/models/attributes/CaptchaAttributeModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"CaptchaAttributeModel.js","names":["CaptchaAttributeModel","AttributeModel","isApplicableModel","contributions","type","update","value","updateLastModification","inputvalue","hasDynamicValidationData"],"sources":["../../../src/models/attributes/CaptchaAttributeModel.js"],"sourcesContent":["// @flow\nimport AttributeModel from \"./AttributeModel\";\n\n/**\n * Password attribute\n */\nexport default class CaptchaAttributeModel extends AttributeModel {\n  /**\n   */\n  static isApplicableModel(contributions: Object): boolean {\n    return contributions.type === \"captcha\";\n  }\n\n  /**\n   */\n  get type(): string {\n    return \"captcha\";\n  }\n\n  /**\n   * Update the attribute by name and value\n   */\n  update(value: string): this {\n    this.updateLastModification();\n    this.inputvalue = value;\n\n    return this;\n  }\n\n  /**\n   */\n  get hasDynamicValidationData(): boolean {\n    return false;\n  }\n}\n"],"mappings":";;;;;;;AACA;AAEA;AACA;AACA;AACe,MAAMA,qBAAqB,SAASC,uBAAc,CAAC;EAChE;AACF;EACE,OAAOC,iBAAiB,CAACC,aAAqB,EAAW;IACvD,OAAOA,aAAa,CAACC,IAAI,KAAK,SAAS;EACzC;;EAEA;AACF;EACE,IAAIA,IAAI,GAAW;IACjB,OAAO,SAAS;EAClB;;EAEA;AACF;AACA;EACEC,MAAM,CAACC,KAAa,EAAQ;IAC1B,IAAI,CAACC,sBAAsB,EAAE;IAC7B,IAAI,CAACC,UAAU,GAAGF,KAAK;IAEvB,OAAO,IAAI;EACb;;EAEA;AACF;EACE,IAAIG,wBAAwB,GAAY;IACtC,OAAO,KAAK;EACd;AACF;AAAC"}
+{"version":3,"file":"CaptchaAttributeModel.js","names":["CaptchaAttributeModel","AttributeModel","isApplicableModel","contributions","type","update","value","updateLastModification","inputvalue","setAnswer","answer","_answer","getAnswer","hasDynamicValidationData"],"sources":["../../../src/models/attributes/CaptchaAttributeModel.js"],"sourcesContent":["// @flow\nimport AttributeModel from \"./AttributeModel\";\n\n/**\n * Password attribute\n */\nexport default class CaptchaAttributeModel extends AttributeModel {\n  _answer: string = \"\";\n\n  /**\n   */\n  static isApplicableModel(contributions: Object): boolean {\n    return contributions.type === \"captcha\";\n  }\n\n  /**\n   */\n  get type(): string {\n    return \"captcha\";\n  }\n\n  /**\n   * Update the attribute by name and value\n   */\n  update(value: string): this {\n    this.updateLastModification();\n    this.inputvalue = value;\n\n    return this;\n  }\n\n  /**\n   */\n  setAnswer(answer: string) {\n    this._answer = answer;\n  }\n\n  /**\n   * Retrieve the given answer for the captcha\n   * The value of this attribute is the token id of the captcha\n   */\n  getAnswer(): string {\n    return this._answer;\n  }\n\n  /**\n   */\n  get hasDynamicValidationData(): boolean {\n    return false;\n  }\n}\n"],"mappings":";;;;;;;;AACA;AAEA;AACA;AACA;AACe,MAAMA,qBAAqB,SAASC,uBAAc,CAAC;EAAA;IAAA;IAAA,+CAC9C,EAAE;EAAA;EAEpB;AACF;EACE,OAAOC,iBAAiB,CAACC,aAAqB,EAAW;IACvD,OAAOA,aAAa,CAACC,IAAI,KAAK,SAAS;EACzC;;EAEA;AACF;EACE,IAAIA,IAAI,GAAW;IACjB,OAAO,SAAS;EAClB;;EAEA;AACF;AACA;EACEC,MAAM,CAACC,KAAa,EAAQ;IAC1B,IAAI,CAACC,sBAAsB,EAAE;IAC7B,IAAI,CAACC,UAAU,GAAGF,KAAK;IAEvB,OAAO,IAAI;EACb;;EAEA;AACF;EACEG,SAAS,CAACC,MAAc,EAAE;IACxB,IAAI,CAACC,OAAO,GAAGD,MAAM;EACvB;;EAEA;AACF;AACA;AACA;EACEE,SAAS,GAAW;IAClB,OAAO,IAAI,CAACD,OAAO;EACrB;;EAEA;AACF;EACE,IAAIE,wBAAwB,GAAY;IACtC,OAAO,KAAK;EACd;AACF;AAAC"}

package/lib/modularui/CaptchaRequest.js

@@ -13,19 +13,32 @@ var _constants = require("../constants");
 class CaptchaRequest {
   constructor() {
     (0, _defineProperty2.default)(this, "_tokenId", void 0);
+    (0, _defineProperty2.default)(this, "_image", void 0);
   }
   /**
    */
+  captchaResponse(response) {
+    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() {
     return (0, _xhr.default)({
       url: (0, _constants.getCaptchaPath)()
-    }).then(response => {
-      this._tokenId = response.tokenId;
-      return response;
-    });
+    }).then(response => this.captchaResponse(response));
   }
 
   /**
+   * Answer the captcha
    */
   send(answer) {
     return (0, _xhr.default)({
@@ -35,10 +48,14 @@ 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() {
+    return this.init();
   }
 }
 var _default = CaptchaRequest;

package/lib/modularui/CaptchaRequest.js.flow

@@ -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/lib/modularui/CaptchaRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"CaptchaRequest.js","names":["CaptchaRequest","init","xhr","url","getCaptchaPath","then","response","_tokenId","tokenId","send","answer","method","HTTP_METHODS","POST","data","catch","error"],"sources":["../../src/modularui/CaptchaRequest.js"],"sourcesContent":["// @flow\nimport xhr from \"../utils/fetch/xhr\";\nimport { getCaptchaPath, HTTP_METHODS } from \"../constants\";\n\ntype CaptchaResponse = {\n  tokenId: string,\n  image: any,\n  valid: boolean,\n};\n\n/**\n */\nclass CaptchaRequest {\n  _tokenId: string;\n\n  /**\n   */\n  init(): Promise<CaptchaResponse> {\n    return xhr({\n      url: getCaptchaPath(),\n    }).then((response) => {\n      this._tokenId = response.tokenId;\n\n      return response;\n    });\n  }\n\n  /**\n   */\n  send(answer?: string): Promise<CaptchaResponse> {\n    return xhr({\n      url: getCaptchaPath(),\n      method: HTTP_METHODS.POST,\n      data: {\n        tokenId: this._tokenId ?? \"\",\n        answer: answer ?? \"\",\n      },\n    }).catch((error) => {\n      this._tokenId = error.response.tokenId;\n      return error.response;\n    });\n  }\n}\n\nexport default CaptchaRequest;\n"],"mappings":";;;;;;;;AACA;AACA;AAQA;AACA;AACA,MAAMA,cAAc,CAAC;EAAA;IAAA;EAAA;EAGnB;AACF;EACEC,IAAI,GAA6B;IAC/B,OAAO,IAAAC,YAAG,EAAC;MACTC,GAAG,EAAE,IAAAC,yBAAc;IACrB,CAAC,CAAC,CAACC,IAAI,CAAEC,QAAQ,IAAK;MACpB,IAAI,CAACC,QAAQ,GAAGD,QAAQ,CAACE,OAAO;MAEhC,OAAOF,QAAQ;IACjB,CAAC,CAAC;EACJ;;EAEA;AACF;EACEG,IAAI,CAACC,MAAe,EAA4B;IAC9C,OAAO,IAAAR,YAAG,EAAC;MACTC,GAAG,EAAE,IAAAC,yBAAc,GAAE;MACrBO,MAAM,EAAEC,uBAAY,CAACC,IAAI;MACzBC,IAAI,EAAE;QACJN,OAAO,EAAE,IAAI,CAACD,QAAQ,IAAI,EAAE;QAC5BG,MAAM,EAAEA,MAAM,IAAI;MACpB;IACF,CAAC,CAAC,CAACK,KAAK,CAAEC,KAAK,IAAK;MAClB,IAAI,CAACT,QAAQ,GAAGS,KAAK,CAACV,QAAQ,CAACE,OAAO;MACtC,OAAOQ,KAAK,CAACV,QAAQ;IACvB,CAAC,CAAC;EACJ;AACF;AAAC,eAEcN,cAAc;AAAA"}
+{"version":3,"file":"CaptchaRequest.js","names":["CaptchaRequest","captchaResponse","response","_tokenId","tokenId","_image","image","valid","error","init","xhr","url","getCaptchaPath","then","send","answer","method","HTTP_METHODS","POST","data","catch","refresh"],"sources":["../../src/modularui/CaptchaRequest.js"],"sourcesContent":["// @flow\nimport xhr from \"../utils/fetch/xhr\";\nimport { getCaptchaPath, HTTP_METHODS } from \"../constants\";\n\ntype CaptchaInitialResponse = {\n  tokenId: string,\n  image: string,\n};\n\ntype CaptchaValidResponse = {\n  valid: boolean,\n};\n\ntype CaptchaInvalidResponse = {\n  tokenId: string,\n  image: string,\n  valid: boolean,\n  error: { id: string },\n};\n\ntype CaptchaResponse = {\n  tokenId: string,\n  image: string,\n  valid: boolean,\n  error: { id: string } | null,\n};\n\n/**\n */\nclass CaptchaRequest {\n  _tokenId: string;\n  _image: string;\n\n  /**\n   */\n  captchaResponse(\n    response:\n      | CaptchaInitialResponse\n      | CaptchaValidResponse\n      | CaptchaInvalidResponse\n  ): CaptchaResponse {\n    this._tokenId = response.tokenId ?? this._tokenId;\n    this._image = response.image ?? this._image;\n\n    return {\n      tokenId: this._tokenId,\n      image: this._image,\n      valid: response.valid ?? false,\n      error: response.error ?? null,\n    };\n  }\n\n  /**\n   * Initiate the captcha request\n   */\n  init(): Promise<CaptchaResponse> {\n    return xhr({\n      url: getCaptchaPath(),\n    }).then((response) => this.captchaResponse(response));\n  }\n\n  /**\n   * Answer the captcha\n   */\n  send(answer?: string): Promise<CaptchaResponse> {\n    return xhr({\n      url: getCaptchaPath(),\n      method: HTTP_METHODS.POST,\n      data: {\n        tokenId: this._tokenId ?? \"\",\n        answer: answer ?? \"\",\n      },\n    })\n      .then((response) => this.captchaResponse(response))\n      .catch((error) => this.captchaResponse(error.response));\n  }\n\n  /**\n   * Reset the captcha and receive a new token and image\n   */\n  refresh(): Promise<CaptchaResponse> {\n    return this.init();\n  }\n}\n\nexport default CaptchaRequest;\n"],"mappings":";;;;;;;;AACA;AACA;AAyBA;AACA;AACA,MAAMA,cAAc,CAAC;EAAA;IAAA;IAAA;EAAA;EAInB;AACF;EACEC,eAAe,CACbC,QAG0B,EACT;IACjB,IAAI,CAACC,QAAQ,GAAGD,QAAQ,CAACE,OAAO,IAAI,IAAI,CAACD,QAAQ;IACjD,IAAI,CAACE,MAAM,GAAGH,QAAQ,CAACI,KAAK,IAAI,IAAI,CAACD,MAAM;IAE3C,OAAO;MACLD,OAAO,EAAE,IAAI,CAACD,QAAQ;MACtBG,KAAK,EAAE,IAAI,CAACD,MAAM;MAClBE,KAAK,EAAEL,QAAQ,CAACK,KAAK,IAAI,KAAK;MAC9BC,KAAK,EAAEN,QAAQ,CAACM,KAAK,IAAI;IAC3B,CAAC;EACH;;EAEA;AACF;AACA;EACEC,IAAI,GAA6B;IAC/B,OAAO,IAAAC,YAAG,EAAC;MACTC,GAAG,EAAE,IAAAC,yBAAc;IACrB,CAAC,CAAC,CAACC,IAAI,CAAEX,QAAQ,IAAK,IAAI,CAACD,eAAe,CAACC,QAAQ,CAAC,CAAC;EACvD;;EAEA;AACF;AACA;EACEY,IAAI,CAACC,MAAe,EAA4B;IAC9C,OAAO,IAAAL,YAAG,EAAC;MACTC,GAAG,EAAE,IAAAC,yBAAc,GAAE;MACrBI,MAAM,EAAEC,uBAAY,CAACC,IAAI;MACzBC,IAAI,EAAE;QACJf,OAAO,EAAE,IAAI,CAACD,QAAQ,IAAI,EAAE;QAC5BY,MAAM,EAAEA,MAAM,IAAI;MACpB;IACF,CAAC,CAAC,CACCF,IAAI,CAAEX,QAAQ,IAAK,IAAI,CAACD,eAAe,CAACC,QAAQ,CAAC,CAAC,CAClDkB,KAAK,CAAEZ,KAAK,IAAK,IAAI,CAACP,eAAe,CAACO,KAAK,CAACN,QAAQ,CAAC,CAAC;EAC3D;;EAEA;AACF;AACA;EACEmB,OAAO,GAA6B;IAClC,OAAO,IAAI,CAACZ,IAAI,EAAE;EACpB;AACF;AAAC,eAEcT,cAAc;AAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beinformed/ui",
-  "version": "1.27.0",
+  "version": "1.27.1",
   "description": "Toolbox for be informed javascript layouts",
   "license": "SEE LICENSE IN LICENSE.md",
   "bugs": "http://support.beinformed.com",
@@ -82,7 +82,7 @@
     "styled-components": "^5.0.0"
   },
   "dependencies": {
-    "@babel/runtime-corejs3": "^7.20.7",
+    "@babel/runtime-corejs3": "^7.20.13",
     "big.js": "^6.2.1",
     "date-fns": "^2.29.3",
     "deepmerge": "^4.2.2",
@@ -113,7 +113,7 @@
     "@commitlint/config-conventional": "^17.4.2",
     "@testing-library/react": "^13.4.0",
     "auditjs": "^4.0.39",
-    "babel-jest": "^29.3.1",
+    "babel-jest": "^29.4.0",
     "babel-plugin-styled-components": "^2.0.7",
     "cherry-pick": "^0.5.0",
     "cross-env": "^7.0.3",
@@ -124,18 +124,18 @@
     "eslint-plugin-ft-flow": "^2.0.3",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jest": "^27.2.1",
-    "eslint-plugin-jsdoc": "^39.6.7",
+    "eslint-plugin-jsdoc": "^39.6.8",
     "eslint-plugin-react": "^7.32.1",
     "eslint-plugin-react-hooks": "^4.5.0",
     "eslint-plugin-you-dont-need-lodash-underscore": "^6.12.0",
-    "flow-bin": "^0.197.0",
+    "flow-bin": "^0.198.1",
     "flow-copy-source": "^2.0.9",
     "flow-typed": "^3.8.0",
     "glob": "^8.1.0",
     "history": "^4.0.0",
     "husky": "^8.0.3",
-    "jest": "^29.3.1",
-    "jest-environment-jsdom": "^29.3.1",
+    "jest": "^29.4.0",
+    "jest-environment-jsdom": "^29.4.0",
     "jest-junit": "^15.0.0",
     "jest-sonar-reporter": "^2.0.0",
     "jscodeshift": "^0.14.0",
@@ -151,7 +151,7 @@
     "redux": "^4.0.0",
     "redux-mock-store": "^1.5.4",
     "redux-thunk": "^2.4.2",
-    "rimraf": "^4.1.1",
+    "rimraf": "^4.1.2",
     "standard-version": "^9.5.0",
     "styled-components": "^5.3.6",
     "xhr-mock": "^2.5.1"

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/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/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/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;
+    };
 };