@gataca/qr 2.0.1 → 2.0.2

package/dist/collection/components/gataca-qr/gataca-qr.js

@@ -1,557 +0,0 @@
-import { h, } from "@stencil/core";
-import alertIcon from "../../assets/icons/gat-icon-alert.svg";
-import successIcon from "../../assets/icons/gat-icon-check.svg";
-import refreshIcon from "../../assets/icons/gat-icon-refresh.svg";
-import logoGataca from "../../assets/images/logo_gataca.svg";
-import "../gataca-qrdisplay/gataca-qrdisplay";
-import { base64UrlEncode, checkMobile, RESULT_STATUS } from "../../utils/utils";
-const DEEP_LINK_PREFIX = "https://gataca.page.link/?apn=com.gatacaapp&ibi=com.gataca.wallet&link=";
-//Default values
-const DEFAULT_SESSION_TIMEOUT = 300; //5mins as in connect
-const DEFAULT_POLLING_FREQ = 3;
-const QR_ROLE_CONNECT = "connect";
-const FUNCTION_ROLES = {
-  connect: "scan",
-  certify: "credential",
-};
-export class GatacaQR {
-  constructor() { this.checkStatus = undefined; this.createSession = undefined; this.successCallback = undefined; this.errorCallback = undefined; this.qrRole = undefined; this.callbackServer = undefined; this.autostart = true; this.autorefresh = false; this.v2 = false; this.qrModalTitle = "Quick Access"; this.qrModalDescription = "Sign up or sign in by scanning the QR Code with the Gataca Wallet"; this.hideBrandTitle = false; this.sessionTimeout = DEFAULT_SESSION_TIMEOUT; this.pollingFrequency = DEFAULT_POLLING_FREQ; this.dynamicLink = true; this.sessionId = undefined; this.authenticationRequest = undefined; this.sessionData = undefined; this.result = RESULT_STATUS.NOT_STARTED; }
-  disconnectedCallback() {
-    this.stop();
-  }
-  async componentDidLoad() {
-    if (this.autostart) {
-      await this.display();
-    }
-  }
-  /**
-   * Force manually the display of a QR
-   */
-  async display() {
-    await this.getSessionId();
-    this.result = RESULT_STATUS.ONGOING;
-    this.poll()
-      .then((data) => {
-      this.result = RESULT_STATUS.SUCCESS;
-      this.sessionData = data;
-      this.gatacaLoginCompleted.emit(data);
-      this.successCallback(data);
-    })
-      .catch((err) => {
-      this.clean();
-      let expired = err === RESULT_STATUS.EXPIRED;
-      if (expired && this.autorefresh) {
-        this.display();
-      }
-      else {
-        if (err !== RESULT_STATUS.NOT_STARTED) {
-          let error = expired
-            ? new Error("User did not scan the QR in the alloted time")
-            : new Error("Provided user credentials couldn't be validated");
-          this.result = err;
-          this.gatacaLoginFailed.emit(error);
-          this.errorCallback(error);
-        }
-      }
-    });
-    if (checkMobile() && this.dynamicLink) {
-      window.location.href = this.getLink();
-    }
-  }
-  /**
-   * Stop manually an ongoing session
-   */
-  async stop() {
-    this.clean();
-    if (this.result === RESULT_STATUS.ONGOING) {
-      this.result = RESULT_STATUS.NOT_STARTED;
-    }
-  }
-  clean() {
-    this.sessionData = undefined;
-    this.sessionId = undefined;
-  }
-  /**
-   * Retrieve manually the session data on a successful login
-   */
-  async getSessionData() {
-    return this.sessionData
-      ? Promise.resolve(this.sessionData)
-      : Promise.reject(new Error("No successful login"));
-  }
-  async getSessionId() {
-    if (this.sessionId) {
-      return this.sessionId;
-    }
-    let { sessionId, authenticationRequest } = await this.createSession();
-    this.sessionId = sessionId;
-    this.authenticationRequest = authenticationRequest;
-    return this.sessionId;
-  }
-  getLink() {
-    if (this.v2 && this.qrRole == QR_ROLE_CONNECT) {
-      return this.authenticationRequest;
-    }
-    let op = FUNCTION_ROLES[this.qrRole];
-    let link = "https://gataca.page.link/" + op + "?";
-    link +=
-      this.qrRole === QR_ROLE_CONNECT
-        ? "session=" + this.sessionId
-        : "process=" + this.sessionId;
-    link +=
-      "&callback=" + base64UrlEncode(encodeURIComponent(this.callbackServer));
-    link = encodeURIComponent(link);
-    return this.dynamicLink ? DEEP_LINK_PREFIX + link : link;
-  }
-  async poll() {
-    let endTime = new Date().getTime() +
-      (this.sessionTimeout || DEFAULT_SESSION_TIMEOUT) * 1000;
-    let interval = (this.pollingFrequency || DEFAULT_POLLING_FREQ) * 1000;
-    let checkFunc = async (component) => {
-      if (component.result === RESULT_STATUS.NOT_STARTED) {
-        return { result: RESULT_STATUS.NOT_STARTED };
-      }
-      let id = await component.getSessionId();
-      return component.checkStatus(id);
-    };
-    let component = this;
-    let checkCondition = async function (resolve, reject) {
-      // If the condition is met, we're done!
-      let { result, data } = await checkFunc(component);
-      switch (result) {
-        case RESULT_STATUS.SUCCESS:
-          resolve(data);
-          break;
-        case RESULT_STATUS.ONGOING:
-          if (component.sessionTimeout > 0 && new Date().getTime() < endTime) {
-            setTimeout(checkCondition, interval, resolve, reject);
-          }
-          else {
-            reject(RESULT_STATUS.EXPIRED);
-          }
-          break;
-        default:
-          reject(result);
-          break;
-      }
-    };
-    return new Promise(checkCondition);
-  }
-  renderQRSection() {
-    switch (this.result) {
-      case RESULT_STATUS.NOT_STARTED:
-        return this.renderRetryButton();
-      case RESULT_STATUS.ONGOING:
-        return this.renderQR(this.getLink(), 300, true);
-      case RESULT_STATUS.EXPIRED:
-        return this.renderRetryButton("QR Code expired");
-      case RESULT_STATUS.FAILED:
-        return this.renderRetryButton("User credentials not validated");
-      case RESULT_STATUS.SUCCESS:
-        return this.renderSuccess();
-    }
-  }
-  renderSuccess() {
-    return (h("div", { class: "success" }, h("img", { src: successIcon, height: 52, width: 52 }), h("p", { class: "successMsg" }, "Successful Connection!")));
-  }
-  renderRetryButton(errorMessage) {
-    return (h("div", { class: "reload" }, h("div", { id: "notify", onClick: () => this.display() }, h("img", { src: refreshIcon, height: 24, width: 24 }), h("p", { class: "qrDescription" }, "Click inside the box to "), errorMessage ? (h("p", { class: "qrDescription bold" }, "Refresh QR Code")) : (h("p", { class: "qrDescription bold" }, "Scan QR Code")), errorMessage && (h("div", { class: "alert" }, h("img", { src: alertIcon, height: 24, width: 24 }), h("p", null, errorMessage)))), h("div", { id: "qrwait" }, this.renderQR("waiting to start a session", 250))));
-  }
-  renderQR(value, size, useLogo) {
-    return (h("gataca-qrdisplay", { qrData: value, rounded: true, size: size, "logo-size": useLogo ? 0.33 : 0 }));
-  }
-  render() {
-    return (h("div", { class: "popUpContainer" }, h("div", { class: "modal-window is-visible", onClick: (event) => {
-        event.stopPropagation();
-      } }, h("div", { class: "modal-window__content" }, h("div", { class: "qrTitleContainer" }, h("p", { class: "qrTitle" }, this.qrModalTitle), !this.hideBrandTitle && (h("p", { class: "qrBrand" }, "by Gataca", " ", h("span", null, h("img", { src: logoGataca })))), this.result !== RESULT_STATUS.SUCCESS && (h("p", { class: "qrDescription" }, this.qrModalDescription))), h("div", { class: "qrSection" }, this.renderQRSection())))));
-  }
-  static get is() { return "gataca-qr"; }
-  static get encapsulation() { return "shadow"; }
-  static get originalStyleUrls() {
-    return {
-      "$": ["gataca-qr.scss"]
-    };
-  }
-  static get styleUrls() {
-    return {
-      "$": ["gataca-qr.css"]
-    };
-  }
-  static get properties() {
-    return {
-      "checkStatus": {
-        "type": "unknown",
-        "mutable": false,
-        "complexType": {
-          "original": "(\n    id?: string\n  ) => Promise<{ result: RESULT_STATUS; data?: any }>",
-          "resolved": "(id?: string) => Promise<{ result: RESULT_STATUS; data?: any; }>",
-          "references": {
-            "Promise": {
-              "location": "global"
-            },
-            "RESULT_STATUS": {
-              "location": "import",
-              "path": "../../utils/utils"
-            }
-          }
-        },
-        "required": false,
-        "optional": true,
-        "docs": {
-          "tags": [],
-          "text": "***Mandatory***\nCheck status function to query the current status of the session\nThe function must query a client endpoint to check the status. That endpoint must return an error if the session has expired."
-        },
-        "defaultValue": "undefined"
-      },
-      "createSession": {
-        "type": "unknown",
-        "mutable": false,
-        "complexType": {
-          "original": "() => Promise<{\n    sessionId: string;\n    authenticationRequest?: string;\n  }>",
-          "resolved": "() => Promise<{ sessionId: string; authenticationRequest?: string; }>",
-          "references": {
-            "Promise": {
-              "location": "global"
-            }
-          }
-        },
-        "required": false,
-        "optional": true,
-        "docs": {
-          "tags": [],
-          "text": "***Mandatory***\nCreate session function to generate a new Session\nUsing V1, it can provide just a session Id\nUsing V2, it must provide also the authentication request. The session Id is the id of the presentation definition"
-        },
-        "defaultValue": "undefined"
-      },
-      "successCallback": {
-        "type": "unknown",
-        "mutable": false,
-        "complexType": {
-          "original": "(data?: any) => void",
-          "resolved": "(data?: any) => void",
-          "references": {}
-        },
-        "required": false,
-        "optional": false,
-        "docs": {
-          "tags": [],
-          "text": "***Mandatory***\nCallback fired upon session correctly verified\nIf not set, session validation wouldn't trigger any action\nThe session data and a possible token will be sent as parameters to the callback"
-        },
-        "defaultValue": "undefined"
-      },
-      "errorCallback": {
-        "type": "unknown",
-        "mutable": false,
-        "complexType": {
-          "original": "(error?: Error) => void",
-          "resolved": "(error?: Error) => void",
-          "references": {
-            "Error": {
-              "location": "global"
-            }
-          }
-        },
-        "required": false,
-        "optional": false,
-        "docs": {
-          "tags": [],
-          "text": "***Mandatory***\nCallback fired upon session expired or invalid\nIf not set, session error would not be handled\nAn error containing information will be passed as parameter"
-        },
-        "defaultValue": "undefined"
-      },
-      "qrRole": {
-        "type": "string",
-        "mutable": false,
-        "complexType": {
-          "original": "string",
-          "resolved": "string",
-          "references": {}
-        },
-        "required": false,
-        "optional": false,
-        "docs": {
-          "tags": [],
-          "text": "***Mandatory***\nDecide if scanning the credential as a verifier to request credentials\nor as an issuer too issue credentials.\nOptions: connect | certify"
-        },
-        "attribute": "qr-role",
-        "reflect": false
-      },
-      "callbackServer": {
-        "type": "string",
-        "mutable": false,
-        "complexType": {
-          "original": "string",
-          "resolved": "string",
-          "references": {}
-        },
-        "required": false,
-        "optional": false,
-        "docs": {
-          "tags": [],
-          "text": "***Mandatory just for V1***\nConnect/Certify Server where the wallet will send the data"
-        },
-        "attribute": "callback-server",
-        "reflect": false
-      },
-      "autostart": {
-        "type": "boolean",
-        "mutable": false,
-        "complexType": {
-          "original": "boolean",
-          "resolved": "boolean",
-          "references": {}
-        },
-        "required": false,
-        "optional": false,
-        "docs": {
-          "tags": [],
-          "text": "_[Optional]_\nSet to enable autoload when the QR is displayed. By default it is true"
-        },
-        "attribute": "autostart",
-        "reflect": false,
-        "defaultValue": "true"
-      },
-      "autorefresh": {
-        "type": "boolean",
-        "mutable": false,
-        "complexType": {
-          "original": "boolean",
-          "resolved": "boolean",
-          "references": {}
-        },
-        "required": false,
-        "optional": false,
-        "docs": {
-          "tags": [],
-          "text": "_[Optional]_\nSet to refresh the session automatically upon expiration. By default it is false"
-        },
-        "attribute": "autorefresh",
-        "reflect": false,
-        "defaultValue": "false"
-      },
-      "v2": {
-        "type": "boolean",
-        "mutable": false,
-        "complexType": {
-          "original": "boolean",
-          "resolved": "boolean",
-          "references": {}
-        },
-        "required": false,
-        "optional": true,
-        "docs": {
-          "tags": [],
-          "text": "_[Optional]_\nSet to use v2 links. The create session must be providing both an authentication request and a session Id"
-        },
-        "attribute": "v-2",
-        "reflect": false,
-        "defaultValue": "false"
-      },
-      "qrModalTitle": {
-        "type": "string",
-        "mutable": false,
-        "complexType": {
-          "original": "string",
-          "resolved": "string",
-          "references": {}
-        },
-        "required": false,
-        "optional": true,
-        "docs": {
-          "tags": [],
-          "text": "_[Optional]_\nModifies the qr headline title"
-        },
-        "attribute": "qr-modal-title",
-        "reflect": false,
-        "defaultValue": "\"Quick Access\""
-      },
-      "qrModalDescription": {
-        "type": "string",
-        "mutable": false,
-        "complexType": {
-          "original": "string",
-          "resolved": "string",
-          "references": {}
-        },
-        "required": false,
-        "optional": true,
-        "docs": {
-          "tags": [],
-          "text": "_[Optional]_\nModifies the Modal description"
-        },
-        "attribute": "qr-modal-description",
-        "reflect": false,
-        "defaultValue": "\"Sign up or sign in by scanning the QR Code with the Gataca Wallet\""
-      },
-      "hideBrandTitle": {
-        "type": "boolean",
-        "mutable": false,
-        "complexType": {
-          "original": "boolean",
-          "resolved": "boolean",
-          "references": {}
-        },
-        "required": false,
-        "optional": true,
-        "docs": {
-          "tags": [],
-          "text": "_[Optional]_\nBoolean to show or not show the gataca brand title"
-        },
-        "attribute": "hide-brand-title",
-        "reflect": false,
-        "defaultValue": "false"
-      },
-      "sessionTimeout": {
-        "type": "number",
-        "mutable": false,
-        "complexType": {
-          "original": "number",
-          "resolved": "number",
-          "references": {}
-        },
-        "required": false,
-        "optional": true,
-        "docs": {
-          "tags": [],
-          "text": "_[Optional]_\nMaximum time window to display the session"
-        },
-        "attribute": "session-timeout",
-        "reflect": false,
-        "defaultValue": "DEFAULT_SESSION_TIMEOUT"
-      },
-      "pollingFrequency": {
-        "type": "number",
-        "mutable": false,
-        "complexType": {
-          "original": "number",
-          "resolved": "number",
-          "references": {}
-        },
-        "required": false,
-        "optional": true,
-        "docs": {
-          "tags": [],
-          "text": "_[Optional]_\nFrequency in seconds to check if the session has been validated"
-        },
-        "attribute": "polling-frequency",
-        "reflect": false,
-        "defaultValue": "DEFAULT_POLLING_FREQ"
-      },
-      "dynamicLink": {
-        "type": "boolean",
-        "mutable": false,
-        "complexType": {
-          "original": "boolean",
-          "resolved": "boolean",
-          "references": {}
-        },
-        "required": false,
-        "optional": true,
-        "docs": {
-          "tags": [],
-          "text": "_[Optional]_\nDisplay a link containing a dynamic link to invoke the wallet if closed"
-        },
-        "attribute": "dynamic-link",
-        "reflect": false,
-        "defaultValue": "true"
-      }
-    };
-  }
-  static get states() {
-    return {
-      "sessionId": {},
-      "authenticationRequest": {},
-      "sessionData": {},
-      "result": {}
-    };
-  }
-  static get events() {
-    return [{
-        "method": "gatacaLoginCompleted",
-        "name": "gatacaLoginCompleted",
-        "bubbles": true,
-        "cancelable": true,
-        "composed": true,
-        "docs": {
-          "tags": [],
-          "text": "GatacaLoginCompleted event, triggered with session data upon login success"
-        },
-        "complexType": {
-          "original": "any",
-          "resolved": "any",
-          "references": {}
-        }
-      }, {
-        "method": "gatacaLoginFailed",
-        "name": "gatacaLoginFailed",
-        "bubbles": true,
-        "cancelable": true,
-        "composed": true,
-        "docs": {
-          "tags": [],
-          "text": "GatacaLoginFailed event, triggered with error upon login failure"
-        },
-        "complexType": {
-          "original": "any",
-          "resolved": "any",
-          "references": {}
-        }
-      }];
-  }
-  static get methods() {
-    return {
-      "display": {
-        "complexType": {
-          "signature": "() => Promise<void>",
-          "parameters": [],
-          "references": {
-            "Promise": {
-              "location": "global"
-            },
-            "RESULT_STATUS": {
-              "location": "import",
-              "path": "../../utils/utils"
-            }
-          },
-          "return": "Promise<void>"
-        },
-        "docs": {
-          "text": "Force manually the display of a QR",
-          "tags": []
-        }
-      },
-      "stop": {
-        "complexType": {
-          "signature": "() => Promise<void>",
-          "parameters": [],
-          "references": {
-            "Promise": {
-              "location": "global"
-            }
-          },
-          "return": "Promise<void>"
-        },
-        "docs": {
-          "text": "Stop manually an ongoing session",
-          "tags": []
-        }
-      },
-      "getSessionData": {
-        "complexType": {
-          "signature": "() => Promise<any>",
-          "parameters": [],
-          "references": {
-            "Promise": {
-              "location": "global"
-            }
-          },
-          "return": "Promise<any>"
-        },
-        "docs": {
-          "text": "Retrieve manually the session data on a successful login",
-          "tags": []
-        }
-      }
-    };
-  }
-}