@gataca/qr 2.0.2 → 2.0.4

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

@@ -0,0 +1,679 @@
+import { h, } from "@stencil/core";
+import "../gataca-qrdisplay/gataca-qrdisplay";
+const PHONE_ICON = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABsAAAAbCAYAAACN1PRVAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAHvSURBVHgB3ZZPTttAFMbfe3YjL7qYLopcpZXSG7Q3CDfIsqrSJpyg5QQtJ2h7glgUdVs4AeEE5AYEQSDAgtnw357Hm0hAQDaeIRFCfFKyeKPxzzPzvc+DUKCZN80GEv1ABgWOQgSdGbOwv7u0nDueV4zjTzUIKhuAZna4vdQFR828azbI0K/TI/qodaLvjlP+tLDGDCs+IKv9Lbsi7kcv0w9541Q0EREPYcoieEQ9KiyECRXHzbpBUOcnYTfPFOOaaGVx9WsLiDrSIp0iU0wFNgIx/AQyc9I/OmOjy+Y8aBvHQcDUYebewc6/Xtk8J5htcg5efEPGhk0JtqkyBjo7DuZcnuO2sqCyKv8rUDmfTS9IBURqBAL+I6CkzBjOMOs22TLY21n8fl17KzXR3uDvb/CQk0GEdfvN07QvpnAOaGfYaRT25JzU6+rnG2tTpcWAy+Cp0m3U/URLms8HWfg/rn6RFaGSs9KQkZMpvGBWNs2Vandt46ac6YNBuc0fDLMaOU5DFybQ8039p/KJ4bq4rwPewtqoM/1gsCm/NfBXvWjgHhhuDAeLyd3qVSifHQULeZkou9EqemLhmUmav8qrZ4GEMGA7ivzjKvfeqGptFV2YdWPMPHHq0cCh3DdpVdLl/XCY9J1gVvbCiWa6N+JLocPFjCsx9cAAAAAASUVORK5CYII=";
+export class GatacaSSIButton {
+  constructor() {
+    this.buttonText = "Easy login";
+    this.checkStatus = undefined;
+    this.createSession = undefined;
+    this.successCallback = undefined;
+    this.errorCallback = undefined;
+    this.qrRole = undefined;
+    this.callbackServer = undefined;
+    this.sessionTimeout = undefined;
+    this.pollingFrequency = undefined;
+    this.autorefresh = false;
+    this.v2 = false;
+    this.qrModalTitle = "Quick Access";
+    this.modalTitleColor = "#4745B7";
+    this.qrModalDescription = "Sign up or sign in by scanning the QR Code with the Gataca Wallet";
+    this.hideBrandTitle = false;
+    this.dynamicLink = true;
+    this.logoSize = 0;
+    this.logoSrc = undefined;
+    this.qrCodeExpiredLabel = "QR Code expired";
+    this.credentialsNotValidatedLabel = "User credentials not validated";
+    this.clickInsideBoxLabel = "Click inside the box to";
+    this.refreshQrLabel = "Refresh QR Code";
+    this.scanQrLabel = "Scan QR Code";
+    this.userNotScanInTimeErrorLabel = "User did not scan the QR in the allowed time";
+    this.credsNotValidatedErrorLabel = "Provided user credentials couldn't be validated";
+    this.failedLoginErrorLabel = "No successful login";
+    this.successLoginLabel = "Successful Connection!";
+    this.byBrandLabel = "by Gataca";
+    this.waitingStartSessionLabel = "waiting to start a session";
+    this.hideQrModalDescription = false;
+    this.open = false;
+    this.qr = (h("gataca-qr", { checkStatus: this.checkStatus, createSession: this.createSession, successCallback: this.successCallback, errorCallback: this.errorCallback, qrRole: this.qrRole, callbackServer: this.callbackServer, sessionTimeout: this.sessionTimeout, pollingFrequency: this.pollingFrequency, autostart: true, autorefresh: this.autorefresh, v2: this.v2, qrModalTitle: this.qrModalTitle, qrModalDescription: this.qrModalDescription, hideBrandTitle: this.hideBrandTitle, dynamicLink: this.dynamicLink, logoSize: this.logoSize, logoSrc: this.logoSrc, modalTitleColor: this.modalTitleColor, qrCodeExpiredLabel: this.qrCodeExpiredLabel, credentialsNotValidatedLabel: this.credentialsNotValidatedLabel, clickInsideBoxLabel: this.clickInsideBoxLabel, refreshQrLabel: this.refreshQrLabel, scanQrLabel: this.scanQrLabel, userNotScanInTimeErrorLabel: this.userNotScanInTimeErrorLabel, credsNotValidatedErrorLabel: this.credsNotValidatedErrorLabel, failedLoginErrorLabel: this.failedLoginErrorLabel, successLoginLabel: this.successLoginLabel, byBrandLabel: this.byBrandLabel, waitingStartSessionLabel: this.waitingStartSessionLabel, hideQrModalDescription: this.hideQrModalDescription }));
+  }
+  /**
+   * Retrieve manually the session data on a successful login
+   */
+  async getSessionData() {
+    return this.qr.getSessionData();
+  }
+  renderModal() {
+    return this.qr;
+  }
+  renderButton() {
+    return (h("div", { class: "gatacaButtonWrapper" }, h("button", { class: "gatacaButton", onClick: () => {
+        this.open = !this.open;
+        if (this.open) {
+          this.qr.display();
+        }
+        else {
+          this.qr.stop();
+        }
+      } }, h("img", { src: PHONE_ICON, class: "buttonImg", alt: this.buttonText }), h("span", null, this.buttonText))));
+  }
+  render() {
+    return (h("div", { class: "buttonContainer" }, this.renderButton(), this.open && this.renderModal()));
+  }
+  static get is() { return "gataca-ssibutton"; }
+  static get encapsulation() { return "shadow"; }
+  static get originalStyleUrls() {
+    return {
+      "$": ["gataca-ssibutton.scss"]
+    };
+  }
+  static get styleUrls() {
+    return {
+      "$": ["gataca-ssibutton.css"]
+    };
+  }
+  static get properties() {
+    return {
+      "buttonText": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "_[Optional]_\nIn the case of being a button, modifies its text"
+        },
+        "attribute": "button-text",
+        "reflect": false,
+        "defaultValue": "\"Easy login\""
+      },
+      "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
+      },
+      "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
+      },
+      "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
+      },
+      "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\""
+      },
+      "modalTitleColor": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "_[Optional]_\nString to set Modal title color"
+        },
+        "attribute": "modal-title-color",
+        "reflect": false,
+        "defaultValue": "\"#4745B7\""
+      },
+      "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"
+      },
+      "logoSize": {
+        "type": "number",
+        "mutable": false,
+        "complexType": {
+          "original": "number",
+          "resolved": "number",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "_[Optional]_\nSize of the logo to display in percentage to the total size [0-1]. 0 means no logo will be displayed. Default is the GATACA logo. Recommended size is around 0.33"
+        },
+        "attribute": "logo-size",
+        "reflect": false,
+        "defaultValue": "0"
+      },
+      "logoSrc": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "_[Optional]_\nLogo to display, just if the logo size is greater than 0. No logo is the GATACA logo."
+        },
+        "attribute": "logo-src",
+        "reflect": false
+      },
+      "qrCodeExpiredLabel": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "_[Optional]_\nString to show when qr code expired"
+        },
+        "attribute": "qr-code-expired-label",
+        "reflect": false,
+        "defaultValue": "\"QR Code expired\""
+      },
+      "credentialsNotValidatedLabel": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "_[Optional]_\nString to show when credentials not validatedd"
+        },
+        "attribute": "credentials-not-validated-label",
+        "reflect": false,
+        "defaultValue": "\"User credentials not validated\""
+      },
+      "clickInsideBoxLabel": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "_[Optional]_\nString to show \"click inside\" label"
+        },
+        "attribute": "click-inside-box-label",
+        "reflect": false,
+        "defaultValue": "\"Click inside the box to\""
+      },
+      "refreshQrLabel": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "_[Optional]_\nString to show \"refresh QR\" label"
+        },
+        "attribute": "refresh-qr-label",
+        "reflect": false,
+        "defaultValue": "\"Refresh QR Code\""
+      },
+      "scanQrLabel": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "_[Optional]_\nString to show \"scan QR\" label"
+        },
+        "attribute": "scan-qr-label",
+        "reflect": false,
+        "defaultValue": "\"Scan QR Code\""
+      },
+      "userNotScanInTimeErrorLabel": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "_[Optional]_\nString to show \"user not scan in time\" error"
+        },
+        "attribute": "user-not-scan-in-time-error-label",
+        "reflect": false,
+        "defaultValue": "\"User did not scan the QR in the allowed time\""
+      },
+      "credsNotValidatedErrorLabel": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "_[Optional]_\nString to show \"provided credentials not validates\" error"
+        },
+        "attribute": "creds-not-validated-error-label",
+        "reflect": false,
+        "defaultValue": "\"Provided user credentials couldn't be validated\""
+      },
+      "failedLoginErrorLabel": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "_[Optional]_\nString to show \"failed login\" error"
+        },
+        "attribute": "failed-login-error-label",
+        "reflect": false,
+        "defaultValue": "\"No successful login\""
+      },
+      "successLoginLabel": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "_[Optional]_\nString to show \"successful login\" label"
+        },
+        "attribute": "success-login-label",
+        "reflect": false,
+        "defaultValue": "\"Successful Connection!\""
+      },
+      "byBrandLabel": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "_[Optional]_\nString to show \"by brand\" label"
+        },
+        "attribute": "by-brand-label",
+        "reflect": false,
+        "defaultValue": "\"by Gataca\""
+      },
+      "waitingStartSessionLabel": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "_[Optional]_\nString to show \"waiting start session\" label"
+        },
+        "attribute": "waiting-start-session-label",
+        "reflect": false,
+        "defaultValue": "\"waiting to start a session\""
+      },
+      "hideQrModalDescription": {
+        "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 QR Modal description"
+        },
+        "attribute": "hide-qr-modal-description",
+        "reflect": false,
+        "defaultValue": "false"
+      }
+    };
+  }
+  static get states() {
+    return {
+      "open": {}
+    };
+  }
+  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 {
+      "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": []
+        }
+      }
+    };
+  }
+}