@gataca/qr

Gataca-QR Components

Since V2, this library is now a list of components provided by Gataca to help the integration of its backends components into your front services.

To use this components (except for the QR Display), you will need an instance of any of the Gataca Components (Connect and Certify). You can also use it with onPremise instances over Gataca Studio.

Component List

Gataca QRDisplay

Just to display QRs with the Gataca format in any required component

Gataca QR

Main component of the library. It has been reworked and simplified, while keeping all it's flexibility.

It displays a qr as an overflow panel to integrate into your site. It requires that you have a backend service integrated with Gataca Connect or Certify.

See its documentation for integration.

Gataca QRWS

This is another version of the QR supporting WebSockets instead of a constant polling to your service. It enables a more updated an elegant architecture, but the complexity gets transported to your backend service which will need to handle the polling or support an Event-oriented architecture.

Gataca SSIButton

This flavour supports the easy login button to integrate into your site instead of a panel. The integration and parameters are analogue to the GatacaQR.

Gataca SSIButtonWS

Same as the SSI Button, but with Websockets :) The integration and parameters are analogue to the GatacaQR.

Gataca AutoQR

WIP

This component allows to simplify the integration by downloading all the configuration from a remote server. However, the integration steps and functions of the selected subcomponent need to be still implemented and provided to the component.

Updating from V1

V1 was too flexible and confusing to integrate. We have removed all unuseful parameters to keep a more simplified process.

Breaking changes

• sessionEndpoint and generationEndpoint have been suppressed.
• createSession and checkStatus functions are now mandatory. The returning parameters of those functions have now changed.
• qrRole is also mandatory. There is no default value. The possible values have changed to "connect" and "certify"
• asButton and buttonText functionality has been suppressed. That is a different component.
• getLoginToken() has been suppressed. Any data that wants to be received from the session (from headers, body or whatever) must be provided by the checkStatus result function.
• sessionTimeout can be removed by introducing a negative value. If removed, the QR will wait until the server provides an error by session expiration.

Improvements

• Logs have been cleaned
• Fix providing feedback on the process result and results either if it expires, fails or successes.
• Stopping the component working upon disappearance
• Autostart and autorefresh capabilities
• Documentation and integration with the new provided components