@gataca/qr 2.0.0

package/dist/types/components/gataca-qr/gataca-qr.d.ts

@@ -0,0 +1,131 @@
+import { EventEmitter } from "../../stencil-public-runtime";
+import "../gataca-qrdisplay/gataca-qrdisplay";
+import { RESULT_STATUS } from "../../utils/utils";
+export declare class GatacaQR {
+  constructor();
+  disconnectedCallback(): void;
+  /**
+   * ***Mandatory***
+   * Check status function to query the current status of the session
+   * The function must query a client endpoint to check the status. That endpoint must return an error if the session has expired.
+   */
+  checkStatus?: (id?: string) => Promise<{
+    result: RESULT_STATUS;
+    data?: any;
+  }>;
+  /**
+   * ***Mandatory***
+   * Create session function to generate a new Session
+   * Using V1, it can provide just a session Id
+   * Using V2, it must provide also the authentication request. The session Id is the id of the presentation definition
+   */
+  createSession?: () => Promise<{
+    sessionId: string;
+    authenticationRequest?: string;
+  }>;
+  /**
+   * ***Mandatory***
+   * Callback fired upon session correctly verified
+   * If not set, session validation wouldn't trigger any action
+   * The session data and a possible token will be sent as parameters to the callback
+   */
+  successCallback: (data?: any) => void;
+  /**
+   * ***Mandatory***
+   * Callback fired upon session expired or invalid
+   * If not set, session error would not be handled
+   * An error containing information will be passed as parameter
+   */
+  errorCallback: (error?: Error) => void;
+  /**
+   * ***Mandatory***
+   * Decide if scanning the credential as a verifier to request credentials
+   * or as an issuer too issue credentials.
+   * Options: connect | certify
+   */
+  qrRole: string;
+  /**
+   * ***Mandatory just for V1***
+   * Connect/Certify Server where the wallet will send the data
+   */
+  callbackServer: string;
+  /**
+   * _[Optional]_
+   * Set to enable autoload when the QR is displayed. By default it is true
+   */
+  autostart: boolean;
+  /**
+   * _[Optional]_
+   * Set to refresh the session automatically upon expiration. By default it is false
+   */
+  autorefresh: boolean;
+  /**
+   * _[Optional]_
+   * Set to use v2 links. The create session must be providing both an authentication request and a session Id
+   */
+  v2?: boolean;
+  /**
+   * _[Optional]_
+   * Modifies the qr headline title
+   */
+  qrModalTitle?: string;
+  /**
+   * _[Optional]_
+   * Modifies the Modal description
+   */
+  qrModalDescription?: string;
+  /**
+   * _[Optional]_
+   * Boolean to show or not show the gataca brand title
+   */
+  hideBrandTitle?: boolean;
+  /**
+   * _[Optional]_
+   * Maximum time window to display the session
+   */
+  sessionTimeout?: number;
+  /**
+   * _[Optional]_
+   * Frequency in seconds to check if the session has been validated
+   */
+  pollingFrequency?: number;
+  /**
+   * _[Optional]_
+   * Display a link containing a dynamic link to invoke the wallet if closed
+   */
+  dynamicLink?: boolean;
+  sessionId?: string;
+  authenticationRequest?: string;
+  sessionData: any;
+  result: RESULT_STATUS;
+  componentDidLoad(): Promise<void>;
+  /**
+   * GatacaLoginCompleted event, triggered with session data upon login success
+   */
+  gatacaLoginCompleted: EventEmitter;
+  /**
+   * GatacaLoginFailed event, triggered with error upon login failure
+   */
+  gatacaLoginFailed: EventEmitter;
+  /**
+   * Force manually the display of a QR
+   */
+  display(): Promise<void>;
+  /**
+   * Stop manually an ongoing session
+   */
+  stop(): Promise<void>;
+  clean(): void;
+  /**
+   * Retrieve manually the session data on a successful login
+   */
+  getSessionData(): Promise<any>;
+  getSessionId(): Promise<string>;
+  getLink(): string;
+  poll(): Promise<unknown>;
+  renderQRSection(): any;
+  renderSuccess(): any;
+  renderRetryButton(errorMessage?: string): any;
+  renderQR(value: string, size: number, useLogo?: boolean): any;
+  render(): any;
+}

package/dist/types/components/gataca-qrdisplay/gataca-qrdisplay.d.ts

@@ -0,0 +1,35 @@
+export declare class GatacaQRDisplay {
+  private qr;
+  componentDidLoad(): void;
+  /**
+   * _[Mandatory]_
+   * Sets the contents of the QR
+   */
+  qrData: string;
+  /**
+   * _[Optional]_
+   * Size of the QR Displayed
+   */
+  size?: number;
+  /**
+   * _[Optional]_
+   * Size 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
+   */
+  logoSize?: number;
+  /**
+   * _[Optional]_
+   * Logo to display, just if the logo size is greater than 0. No logo is the GATACA logo.
+   */
+  logoSrc?: string;
+  /**
+   * _[Optional]_
+   * QR Color.
+   */
+  qrColor?: string;
+  /**
+   * _[Optional]_
+   * Round usage
+   */
+  rounded?: boolean;
+  render(): any;
+}

package/dist/types/components/gataca-qrws/gataca-qrws.d.ts

@@ -0,0 +1,124 @@
+import { EventEmitter } from "../../stencil-public-runtime";
+import "../gataca-qrdisplay/gataca-qrdisplay";
+import { RESULT_STATUS, WSResponse } from "../../utils/utils";
+export declare class GatacaQRWS {
+  constructor();
+  disconnectedCallback(): void;
+  /**
+   * ***Mandatory***
+   * Callback fired upon session correctly verified
+   * If not set, session validation wouldn't trigger any action
+   * The session data and a possible token will be sent as parameters to the callback
+   */
+  successCallback: (data?: any) => void;
+  /**
+   * ***Mandatory***
+   * Callback fired upon session expired or invalid
+   * If not set, session error would not be handled
+   * An error containing information will be passed as parameter
+   */
+  errorCallback: (error?: Error) => void;
+  /**
+   * ***Mandatory***
+   * Decide if scanning the credential as a verifier to request credentials
+   * or as an issuer too issue credentials.
+   * Options: connect | certify
+   */
+  qrRole: string;
+  /**
+   * ***Mandatory just for V1***
+   * Connect/Certify Server where the wallet will send the data
+   */
+  callbackServer: string;
+  /**
+   * ***Mandatory***
+   * WS Endpoint on your service to be invoked upon display
+   */
+  socketEndpoint: string;
+  /**
+   * ***Mandatory***
+   * Maximum time window to display the session and keep the websocket connection. It's needed to ensure the socket is closed.
+   */
+  sessionTimeout?: number;
+  /**
+   * [Optional]
+   * Function to send a message to the server upon socket creation
+   */
+  wsOnOpen: (socket: WebSocket) => void;
+  /**
+   * **RECOMMENDED**
+   * Callback to invoke an a message has been received on the socket. It provides the socket itself and the message as parameters.
+   * If not used, the messages provided by the server on the Socket connection must conform to the WSReponse interface
+   * If used, an Event named **sessionMsg** must be triggered with a WSReponse as data
+   */
+  wsOnMessage: (socket: WebSocket, msg: MessageEvent) => void;
+  /**
+   * _[Optional]_
+   * Set to enable autoload when the QR is displayed. By default it is true
+   */
+  autostart: boolean;
+  /**
+   * _[Optional]_
+   * Set to refresh the session automatically upon expiration. By default it is false
+   */
+  autorefresh: boolean;
+  /**
+   * **RECOMMENDED**
+   * Set to use v2 links. The create session must be providing both an authentication request and a session Id
+   */
+  v2?: boolean;
+  /**
+   * _[Optional]_
+   * Modifies the qr headline title
+   */
+  qrModalTitle?: string;
+  /**
+   * _[Optional]_
+   * Modifies the Modal description
+   */
+  qrModalDescription?: string;
+  /**
+   * _[Optional]_
+   * Boolean to show or not show the gataca brand title
+   */
+  hideBrandTitle?: boolean;
+  /**
+   * _[Optional]_
+   * Display a link containing a dynamic link to invoke the wallet if closed
+   */
+  dynamicLink?: boolean;
+  sessionId?: string;
+  authenticationRequest?: string;
+  sessionData: any;
+  result: RESULT_STATUS;
+  componentDidLoad(): Promise<void>;
+  /**
+   * GatacaLoginCompleted event, triggered with session data upon login success
+   */
+  gatacaLoginCompleted: EventEmitter;
+  /**
+   * GatacaLoginFailed event, triggered with error upon login failure
+   */
+  gatacaLoginFailed: EventEmitter;
+  socket: WebSocket;
+  /**
+   * Force manually the display of a QR
+   */
+  display(): Promise<void>;
+  sessionMsgReceived(event: CustomEvent<WSResponse>): void;
+  handleWSResponse(wsresp: WSResponse): void;
+  /**
+   * Stop manually an ongoing session
+   */
+  stop(): Promise<void>;
+  /**
+   * Retrieve manually the session data on a successful login
+   */
+  getSessionData(): Promise<any>;
+  getLink(): string;
+  renderQRSection(): any;
+  renderSuccess(): any;
+  renderRetryButton(errorMessage?: string): any;
+  renderQR(value: string, size: number, useLogo?: boolean): any;
+  render(): any;
+}

package/dist/types/components/gataca-ssibutton/gataca-ssibutton.d.ts

@@ -0,0 +1,114 @@
+import { EventEmitter } from "../../stencil-public-runtime";
+import "../gataca-qrdisplay/gataca-qrdisplay";
+import { RESULT_STATUS } from "../../utils/utils";
+import { GatacaQR } from "../gataca-qr/gataca-qr";
+export declare class GatacaSSIButton {
+  qr: GatacaQR;
+  constructor();
+  /**
+   * _[Optional]_
+   * In the case of being a button, modifies its text
+   */
+  buttonText?: string;
+  /**
+   * ***Mandatory***
+   * Check status function to query the current status of the session
+   * The function must query a client endpoint to check the status. That endpoint must return an error if the session has expired.
+   */
+  checkStatus?: (id?: string) => Promise<{
+    result: RESULT_STATUS;
+    data?: any;
+  }>;
+  /**
+   * ***Mandatory***
+   * Create session function to generate a new Session
+   * Using V1, it can provide just a session Id
+   * Using V2, it must provide also the authentication request. The session Id is the id of the presentation definition
+   */
+  createSession?: () => Promise<{
+    sessionId: string;
+    authenticationRequest?: string;
+  }>;
+  /**
+   * ***Mandatory***
+   * Callback fired upon session correctly verified
+   * If not set, session validation wouldn't trigger any action
+   * The session data and a possible token will be sent as parameters to the callback
+   */
+  successCallback: (data?: any) => void;
+  /**
+   * ***Mandatory***
+   * Callback fired upon session expired or invalid
+   * If not set, session error would not be handled
+   * An error containing information will be passed as parameter
+   */
+  errorCallback: (error?: Error) => void;
+  /**
+   * ***Mandatory***
+   * Decide if scanning the credential as a verifier to request credentials
+   * or as an issuer too issue credentials.
+   * Options: connect | certify
+   */
+  qrRole: string;
+  /**
+   * ***Mandatory just for V1***
+   * Connect/Certify Server where the wallet will send the data
+   */
+  callbackServer: string;
+  /**
+   * _[Optional]_
+   * Maximum time window to display the session
+   */
+  sessionTimeout?: number;
+  /**
+   * _[Optional]_
+   * Frequency in seconds to check if the session has been validated
+   */
+  pollingFrequency?: number;
+  /**
+   * _[Optional]_
+   * Set to refresh the session automatically upon expiration. By default it is false
+   */
+  autorefresh: boolean;
+  /**
+   * _[Optional]_
+   * Set to use v2 links. The create session must be providing both an authentication request and a session Id
+   */
+  v2?: boolean;
+  /**
+   * _[Optional]_
+   * Modifies the qr headline title
+   */
+  qrModalTitle?: string;
+  /**
+   * _[Optional]_
+   * Modifies the Modal description
+   */
+  qrModalDescription?: string;
+  /**
+   * _[Optional]_
+   * Boolean to show or not show the gataca brand title
+   */
+  hideBrandTitle?: boolean;
+  /**
+   * _[Optional]_
+   * Display a link containing a dynamic link to invoke the wallet if closed
+   */
+  dynamicLink?: boolean;
+  open: boolean;
+  /**
+   * GatacaLoginCompleted event, triggered with session data upon login success
+   */
+  gatacaLoginCompleted: EventEmitter;
+  /**
+   * GatacaLoginFailed event, triggered with error upon login failure
+   */
+  gatacaLoginFailed: EventEmitter;
+  /**
+   * Retrieve manually the session data on a successful login
+   */
+  getSessionData(): Promise<any>;
+  renderModal(): GatacaQR;
+  renderButton(): any;
+  render(): any;
+}

package/dist/types/components/gataca-ssibuttonws/gataca-ssibuttonws.d.ts

@@ -0,0 +1,110 @@
+import { EventEmitter } from "../../stencil-public-runtime";
+import { GatacaQRWS } from "../gataca-qrws/gataca-qrws";
+export declare class GatacaSSIButtonWS {
+  qr: GatacaQRWS;
+  constructor();
+  /**
+   * _[Optional]_
+   * In the case of being a button, modifies its text
+   */
+  buttonText?: string;
+  /**
+   * ***Mandatory***
+   * Callback fired upon session correctly verified
+   * If not set, session validation wouldn't trigger any action
+   * The session data and a possible token will be sent as parameters to the callback
+   */
+  successCallback: (data?: any) => void;
+  /**
+   * ***Mandatory***
+   * Callback fired upon session expired or invalid
+   * If not set, session error would not be handled
+   * An error containing information will be passed as parameter
+   */
+  errorCallback: (error?: Error) => void;
+  /**
+   * ***Mandatory***
+   * Decide if scanning the credential as a verifier to request credentials
+   * or as an issuer too issue credentials.
+   * Options: connect | certify
+   */
+  qrRole: string;
+  /**
+   * ***Mandatory just for V1***
+   * Connect/Certify Server where the wallet will send the data
+   */
+  callbackServer: string;
+  /**
+   * ***Mandatory***
+   * WS Endpoint on your service to be invoked upon display
+   */
+  socketEndpoint: string;
+  /**
+   * ***Mandatory***
+   * Maximum time window to display the session and keep the websocket connection. It's needed to ensure the socket is closed.
+   */
+  sessionTimeout?: number;
+  /**
+   * [Optional]
+   * Function to send a message to the server upon socket creation
+   */
+  wsOnOpen: (socket: WebSocket) => void;
+  /**
+   * **RECOMMENDED**
+   * Callback to invoke an a message has been received on the socket. It provides the socket itself and the message as parameters.
+   * If not used, the messages provided by the server on the Socket connection must conform to the WSReponse interface
+   * If used, an Event named **sessionMsg** must be triggered with a WSReponse as data
+   */
+  wsOnMessage: (socket: WebSocket, msg: MessageEvent) => void;
+  /**
+   * _[Optional]_
+   * Set to enable autoload when the QR is displayed. By default it is true
+   */
+  autostart: boolean;
+  /**
+   * _[Optional]_
+   * Set to refresh the session automatically upon expiration. By default it is false
+   */
+  autorefresh: boolean;
+  /**
+   * **RECOMMENDED**
+   * Set to use v2 links. The create session must be providing both an authentication request and a session Id
+   */
+  v2?: boolean;
+  /**
+   * _[Optional]_
+   * Modifies the qr headline title
+   */
+  qrModalTitle?: string;
+  /**
+   * _[Optional]_
+   * Modifies the Modal description
+   */
+  qrModalDescription?: string;
+  /**
+   * _[Optional]_
+   * Boolean to show or not show the gataca brand title
+   */
+  hideBrandTitle?: boolean;
+  /**
+   * _[Optional]_
+   * Display a link containing a dynamic link to invoke the wallet if closed
+   */
+  dynamicLink?: boolean;
+  open: boolean;
+  /**
+   * GatacaLoginCompleted event, triggered with session data upon login success
+   */
+  gatacaLoginCompleted: EventEmitter;
+  /**
+   * GatacaLoginFailed event, triggered with error upon login failure
+   */
+  gatacaLoginFailed: EventEmitter;
+  /**
+   * Retrieve manually the session data on a successful login
+   */
+  getSessionData(): Promise<any>;
+  renderModal(): GatacaQRWS;
+  renderButton(): any;
+  render(): any;
+}