@gataca/qr 0.0.7

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

@@ -0,0 +1,85 @@
+import { EventEmitter } from "../../stencil-public-runtime";
+import { QRConfig, RESULT_STATUS } from "../../utils";
+import { GatacaQR } from "../gataca-qr/gataca-qr";
+import { GatacaQRWS } from "../gataca-qrws/gataca-qrws";
+import { GatacaSSIButton } from "../gataca-ssibutton/gataca-ssibutton";
+import { GatacaSSIButtonWS } from "../gataca-ssibuttonws/gataca-ssibuttonws";
+export declare class GatacaAutoQR {
+  qr: GatacaQRWS | GatacaQR | GatacaSSIButton | GatacaSSIButtonWS;
+  constructor();
+  /**
+   * ***Mandatory***
+   * ID of the QR configuration to display
+   */
+  configId: string;
+  /**
+   * ___Optional___
+   * ConfigURL Repository to download the config from
+   */
+  configRepository: 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;
+  /**
+   * ___Just for polling flavour___
+   * ***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;
+  /**
+   * ___Just for polling flavour___
+   * ***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 v="3", it can provide just a session Id
+   * Using another version, it must provide also the authentication request. The session Id is the id of the presentation definition
+   */
+  createSession?: () => Promise<{
+    sessionId: string;
+    authenticationRequest?: string;
+  }>;
+  /**
+   * ___Just for WS flavour___
+   * [Optional]
+   * Function to send a message to the server upon socket creation
+   */
+  wsOnOpen: (socket: WebSocket) => void;
+  /**
+   * ___Just for WS flavour___
+   * **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;
+  config?: QRConfig;
+  loading?: 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>;
+  selectQR(): void;
+  render(): any;
+}

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

@@ -0,0 +1,9 @@
+import React from "react";
+declare type IQRProps = {
+  value: string;
+  useLogo?: boolean;
+  logoSrc?: string;
+  size?: number;
+};
+export declare const QR: React.FC<IQRProps>;
+export {};

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

@@ -0,0 +1,13 @@
+import React from "react";
+declare type IReadQRProps = {
+  modalWidth?: number;
+  renderQR(value: string, useLogo?: boolean, size?: number): any;
+  url: string;
+  sizeQR?: number;
+  readQrMessages?: {
+    title?: string;
+    description?: string;
+  };
+};
+export declare const ReadQR: React.FC<IReadQRProps>;
+export {};

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

@@ -0,0 +1,2 @@
+import React from "react";
+export declare const AnimatedLoader: React.FC;

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

@@ -0,0 +1,13 @@
+import React from "react";
+declare type IRetryButtonProps = {
+  errorMessage?: string;
+  modalWidth?: number;
+  clickInsideBoxLabel?: string;
+  refreshQrLabel?: string;
+  scanQrLabel?: string;
+  waitingStartSessionLabel?: string;
+  display: (x?: any) => void;
+  renderRetryQR(value: string, useLogo?: boolean): any;
+};
+export declare const RetryButton: React.FC<IRetryButtonProps>;
+export {};

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

@@ -0,0 +1,7 @@
+import React from "react";
+declare type ISuccessProps = {
+  modalHeight?: number;
+  successLoginLabel?: string;
+};
+export declare const Success: React.FC<ISuccessProps>;
+export {};

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

@@ -0,0 +1,246 @@
+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 v="3", it can provide just a session Id
+   * Using another version, 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 just for V1***
+   * 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]_
+   * If 3, handle deeplink redirects and deprecates (remove) v1 functionality. If not, the create session must be providing both an authentication request and a session Id
+   */
+  v?: string;
+  /**
+   * _[Optional]_
+   * Modifies the qr headline title
+   */
+  qrModalTitle?: string;
+  /**
+   * _[Optional]_
+   * String to set Modal title color
+   */
+  modalTitleColor?: string;
+  /**
+   * _[Optional]_
+   * Modifies the Modal description
+   */
+  qrModalDescription?: string;
+  /**
+   * _[Optional]_
+   * Boolean to show or not show the modal title, brandTitle and description
+   */
+  hideModalTexts?: boolean;
+  /**
+   * _[Optional]_
+   * Boolean to show or not show the modal title, brandTitle and description
+   */
+  hideModalBoxShadow?: boolean;
+  /**
+   * _[Optional]_
+   * Boolean to show or not show the gataca brand title
+   */
+  hideBrandTitle?: boolean;
+  /**
+   * _[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]_
+   * Size of QR Displayed
+   */
+  qrSize?: number;
+  /**
+   * _[Optional]_
+   * Width of the modal
+   */
+  modalWidth?: number;
+  /**
+   * _[Optional]_
+   * Height of the modal
+   */
+  modalHeight?: number;
+  /**
+   * _[Optional]_
+   * String to show when qr code expired
+   */
+  qrCodeExpiredLabel?: string;
+  /**
+   * _[Optional]_
+   * String to show when credentials not validatedd
+   */
+  credentialsNotValidatedLabel?: string;
+  /**
+   * _[Optional]_
+   * String to show "click inside" label
+   */
+  clickInsideBoxLabel?: string;
+  /**
+   * _[Optional]_
+   * String to show "refresh QR" label
+   */
+  refreshQrLabel?: string;
+  /**
+   * _[Optional]_
+   * String to show "scan QR" label
+   */
+  scanQrLabel?: string;
+  /**
+   * _[Optional]_
+   * String to show "user not scan in time" error
+   */
+  userNotScanInTimeErrorLabel?: string;
+  /**
+   * _[Optional]_
+   * String to show "provided credentials not validates" error
+   */
+  credsNotValidatedErrorLabel?: string;
+  /**
+   * _[Optional]_
+   * String to show "failed login" error
+   */
+  failedLoginErrorLabel?: string;
+  /**
+   * _[Optional]_
+   * String to show "successful login" label
+   */
+  successLoginLabel?: string;
+  /**
+   * _[Optional]_
+   * String to show "by brand" label
+   */
+  byBrandLabel?: string;
+  /**
+   * _[Optional]_
+   * String to show "waiting start session" label
+   */
+  waitingStartSessionLabel?: string;
+  /**
+   * _[Optional]_
+   * String title to show when QR already read
+   */
+  readQrTitle?: string;
+  /**
+   * _[Optional]_
+   * String description to show when QR already read
+   */
+  readQrDescription?: string;
+  /**
+   * _[Optional]_
+   * Boolean to show or not show the QR Modal description
+   */
+  hideQrModalDescription?: 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;
+  renderReadQR(readQrMessages?: {
+    title: any;
+    description: any;
+  }): any;
+  renderQR(value: string, useLogo?: boolean): any;
+  renderRetryQR(value: string, 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/components/qr/QR.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+declare type IQRProps = {
+  value: string;
+  useLogo?: boolean;
+  logoSrc?: string;
+  size?: number;
+};
+export declare const QR: React.FC<IQRProps>;
+export {};

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

@@ -0,0 +1,13 @@
+import React from "react";
+declare type IReadQRProps = {
+  modalWidth?: number;
+  renderQR(value: string, useLogo?: boolean, size?: number): any;
+  url: string;
+  sizeQR?: number;
+  readQrMessages?: {
+    title?: string;
+    description?: string;
+  };
+};
+export declare const ReadQR: React.FC<IReadQRProps>;
+export {};

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

@@ -0,0 +1,2 @@
+import React from "react";
+export declare const AnimatedLoader: React.FC;

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

@@ -0,0 +1,13 @@
+import React from "react";
+declare type IRetryButtonProps = {
+  errorMessage?: string;
+  modalWidth?: number;
+  clickInsideBoxLabel?: string;
+  refreshQrLabel?: string;
+  scanQrLabel?: string;
+  waitingStartSessionLabel?: string;
+  display: (x?: any) => void;
+  renderRetryQR(value: string, useLogo?: boolean): any;
+};
+export declare const RetryButton: React.FC<IRetryButtonProps>;
+export {};

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

@@ -0,0 +1,7 @@
+import React from "react";
+declare type ISuccessProps = {
+  modalHeight?: number;
+  successLoginLabel?: string;
+};
+export declare const Success: React.FC<ISuccessProps>;
+export {};