@gataca/qr 2.0.2 → 2.0.4

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

@@ -0,0 +1,566 @@
+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=";
+const DEFAULT_SESSION_TIMEOUT = 300;
+const QR_ROLE_CONNECT = "connect";
+const FUNCTION_ROLES = {
+  connect: "scan",
+  certify: "credential",
+};
+export class GatacaQRWS {
+  constructor() { this.successCallback = undefined; this.errorCallback = undefined; this.qrRole = undefined; this.callbackServer = undefined; this.socketEndpoint = undefined; this.sessionTimeout = DEFAULT_SESSION_TIMEOUT; this.wsOnOpen = undefined; this.wsOnMessage = 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.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() {
+    let socket = new WebSocket(this.socketEndpoint);
+    setTimeout(() => {
+      this.socket.close(1000, "");
+    }, 1000 * this.sessionTimeout);
+    this.socket = socket;
+    socket.onopen = () => {
+      if (this.wsOnOpen)
+        this.wsOnOpen(this.socket);
+    };
+    socket.onmessage = (msg) => {
+      if (this.wsOnMessage) {
+        this.wsOnMessage(this.socket, msg);
+      }
+      else {
+        let wsresp = JSON.parse(msg.data);
+        if (!!wsresp.sessionId) {
+          this.handleWSResponse(wsresp);
+        }
+      }
+    };
+    socket.onerror = () => {
+      let error = new Error("Error connecting with server");
+      this.result = RESULT_STATUS.FAILED;
+      this.gatacaLoginFailed.emit(error);
+      this.errorCallback(error);
+      socket.close(1000, "");
+    };
+    socket.onclose = () => {
+      if (this.result === RESULT_STATUS.ONGOING) {
+        this.result = RESULT_STATUS.EXPIRED;
+      }
+      if (this.result === RESULT_STATUS.EXPIRED) {
+        if (this.autorefresh) {
+          this.display();
+        }
+        else {
+          let error = new Error("User did not scan the QR in the alloted time");
+          this.gatacaLoginFailed.emit(error);
+          this.errorCallback(error);
+        }
+      }
+    };
+    if (checkMobile() && this.dynamicLink) {
+      window.location.href = this.getLink();
+    }
+  }
+  sessionMsgReceived(event) {
+    let wsresp = event.detail;
+    this.handleWSResponse(wsresp);
+  }
+  handleWSResponse(wsresp) {
+    this.result = wsresp.result;
+    switch (wsresp.result) {
+      case RESULT_STATUS.ONGOING:
+        this.sessionId = wsresp.sessionId;
+        this.authenticationRequest = wsresp.authenticationRequest;
+        break;
+      case RESULT_STATUS.SUCCESS:
+        this.sessionData = wsresp.authenticatedUserData;
+        this.gatacaLoginCompleted.emit(wsresp.authenticatedUserData);
+        this.successCallback(wsresp.authenticatedUserData);
+        this.socket.close(1000, "");
+        break;
+      case RESULT_STATUS.FAILED:
+        this.socket.close();
+        let error = new Error("Provided user credentials couldn't be validated");
+        this.gatacaLoginFailed.emit(error);
+        this.errorCallback(error);
+        break;
+      case RESULT_STATUS.EXPIRED:
+        this.socket.close();
+        if (this.autorefresh) {
+          this.display();
+        }
+        else {
+          let error = new Error("User did not scan the QR in the alloted time");
+          this.gatacaLoginFailed.emit(error);
+          this.errorCallback(error);
+        }
+    }
+  }
+  /**
+   * Stop manually an ongoing session
+   */
+  async stop() {
+    this.sessionData = undefined;
+    this.sessionId = undefined;
+    this.socket.close(1000, "Client stopped the connection");
+  }
+  /**
+   * 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"));
+  }
+  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;
+  }
+  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-qrws"; }
+  static get encapsulation() { return "shadow"; }
+  static get originalStyleUrls() {
+    return {
+      "$": ["gataca-qrws.scss"]
+    };
+  }
+  static get styleUrls() {
+    return {
+      "$": ["gataca-qrws.css"]
+    };
+  }
+  static get properties() {
+    return {
+      "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
+      },
+      "socketEndpoint": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "***Mandatory***\nWS Endpoint on your service to be invoked upon display"
+        },
+        "attribute": "socket-endpoint",
+        "reflect": false
+      },
+      "sessionTimeout": {
+        "type": "number",
+        "mutable": false,
+        "complexType": {
+          "original": "number",
+          "resolved": "number",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "***Mandatory***\nMaximum time window to display the session and keep the websocket connection. It's needed to ensure the socket is closed."
+        },
+        "attribute": "session-timeout",
+        "reflect": false,
+        "defaultValue": "DEFAULT_SESSION_TIMEOUT"
+      },
+      "wsOnOpen": {
+        "type": "unknown",
+        "mutable": false,
+        "complexType": {
+          "original": "(socket: WebSocket) => void",
+          "resolved": "(socket: WebSocket) => void",
+          "references": {
+            "WebSocket": {
+              "location": "global"
+            }
+          }
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "[Optional]\nFunction to send a message to the server upon socket creation"
+        }
+      },
+      "wsOnMessage": {
+        "type": "unknown",
+        "mutable": false,
+        "complexType": {
+          "original": "(socket: WebSocket, msg: MessageEvent) => void",
+          "resolved": "(socket: WebSocket, msg: MessageEvent<any>) => void",
+          "references": {
+            "WebSocket": {
+              "location": "global"
+            },
+            "MessageEvent": {
+              "location": "global"
+            }
+          }
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "**RECOMMENDED**\nCallback to invoke an a message has been received on the socket. It provides the socket itself and the message as parameters.\nIf not used, the messages provided by the server on the Socket connection must conform to the WSReponse interface\nIf used, an Event named **sessionMsg** must be triggered with a WSReponse as data"
+        }
+      },
+      "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": "**RECOMMENDED**\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"
+      },
+      "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"
+            },
+            "MessageEvent": {
+              "location": "global"
+            },
+            "WSResponse": {
+              "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": []
+        }
+      }
+    };
+  }
+  static get listeners() {
+    return [{
+        "name": "sessionMsg",
+        "method": "sessionMsgReceived",
+        "target": undefined,
+        "capture": true,
+        "passive": false
+      }];
+  }
+}

package/dist/collection/components/gataca-ssibutton/gataca-ssibutton.css

@@ -0,0 +1,116 @@
+/* http://meyerweb.com/eric/tools/css/reset/ 
+   v2.0 | 20110126
+   License: none (public domain)
+*/
+@import url("https://fonts.googleapis.com/css2?family=Work+Sans:wght@300;400&display=swap");
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed,
+figure, figcaption, footer, header, hgroup,
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video {
+  margin: 0;
+  padding: 0;
+  border: 0;
+  font-size: 100%;
+  font: inherit;
+  vertical-align: baseline;
+}
+
+/* HTML5 display-role reset for older browsers */
+article, aside, details, figcaption, figure,
+footer, header, hgroup, menu, nav, section {
+  display: block;
+}
+
+body {
+  line-height: 1;
+}
+
+ol, ul {
+  list-style: none;
+}
+
+blockquote, q {
+  quotes: none;
+}
+
+blockquote:before, blockquote:after,
+q:before, q:after {
+  content: "";
+  content: none;
+}
+
+table {
+  border-collapse: collapse;
+  border-spacing: 0;
+}
+
+/*
+QR COMPONENT  
+*/
+.img-fluid {
+  height: auto;
+  max-width: 50%;
+}
+
+img {
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.buttonContainer {
+  display: inline-block;
+  text-align: right;
+  padding: 10px;
+  position: relative;
+}
+
+.gatacaButtonWrapper {
+  margin: 8px;
+}
+.gatacaButtonWrapper .gatacaButton {
+  display: flex;
+  min-width: 100px;
+  padding: 8px 8px;
+  background-color: white;
+  font-size: 12px;
+  font-family: "Work Sans", sans-serif;
+  letter-spacing: 1px;
+  font-weight: 2;
+  justify-content: space-between;
+  align-items: center;
+  border-radius: 6px;
+  border: 1px solid rgba(24, 27, 94, 0.5);
+  color: rgba(24, 27, 94, 0.8);
+  box-shadow: 0px 1px 3px rgba(48, 48, 48, 0.15);
+  cursor: pointer;
+}
+.gatacaButtonWrapper .gatacaButton > span {
+  margin-right: 10px;
+}
+.gatacaButtonWrapper .gatacaButton:hover {
+  box-shadow: 0px 2px 8px rgba(48, 48, 48, 0.1);
+}
+.gatacaButtonWrapper .buttonText {
+  text-align: right;
+  font-size: 8px;
+  color: rgba(24, 27, 94, 0.5);
+  font-family: "Helvetica Neue", sans-serif;
+  letter-spacing: 1px;
+  padding-right: 8px;
+  font-weight: 1;
+}
+.gatacaButtonWrapper .buttonImg {
+  height: 25px;
+  width: 25px;
+  margin: 0;
+  margin-right: 20px;
+}