Fingo SDK

🚀 Introducción

El SDK Fingo facilita la integración de widgets en tus aplicaciones. Con un manejo eficiente de estados, eventos y un flujo simplificado, Fingo ofrece una experiencia de desarrollo suave y eficaz.

📦 Instalación

1. Instalar el paquete

Para instalar fingo-js, simplemente utiliza el siguiente comando:

# Usando npm
npm i @fair-bank/fingo-js

# Usando yarn
yarn add @fair-bank/fingo-js

2. Configuración del Registro

Dependiendo de la configuración de tu proyecto, puedes establecer el registro a nivel de instancia o proyecto:

A nivel de instancia:

echo "@fair-bank:registry=https://gitlab.com/api/v4/packages/npm/" >> .npmrc

A nivel de proyecto:

echo "@fair-bank:registry=https://gitlab.com/api/v4/projects/49032018/packages/npm/" > .npmrc

🛠️ Uso Básico

1. Inicialización

const fingo = new Fingo(widgetId, authToken, userInfo, companyInfo);

2. Abrir el widget

fingo.open();

3. Escuchar eventos

fingo.on('SDKError', (error) => {
  console.error('Ha ocurrido un error:', error);
});

fingo.on('SDKStateChange', (state) => {
  console.log('Nuevo estado:', state);
});

🔧 Métodos

open()

Este método permite abrir el widget.

• Uso:

fingo.open();

close()

Cierra el widget si está abierto.

• Uso:

fingo.close();

destroy()

Destruye el widget y libera los recursos asociados. Una vez llamado este método, el widget no puede volver a usarse sin crear una nueva instancia.

• Uso:

fingo.destroy();

retry()

Reintenta inicializar el widget en caso de un fallo anterior.

• Uso:

fingo.retry();

on(eventName, listener)

Permite a los usuarios suscribirse a eventos específicos emitidos por el SDK.

• Uso:

fingo.on('eventName', callbackFunction);

• Parámetros:
  • eventName: Nombre del evento al que se desea suscribir.
  • listener: Función callback que se ejecuta cuando se emite el evento.

📢 Eventos

El SDK emite varios eventos para ayudarte a comprender y responder a lo que está sucediendo durante su ciclo de vida. Puedes escuchar estos eventos utilizando el método on().

SDKError

Se emite cuando se produce un error en el SDK.

• Parámetros:
  • code: Código del error.
  • message: Descripción detallada del error.

instance.on('SDKError', (error) => {
  console.log(error.code, error.message);
});

SDKError

Se emite cuando se cambia el estado del widget.

• Parámetros:
  • state: El nuevo estado del widget.

instance.on('SDKStateChange', (stateInfo) => {
  console.log(stateInfo.state);
});

🛑 Manejo de Errores

El SDK está diseñado para manejar errores internamente y proporcionar retroalimentación a través del evento SDKError. Asegúrate de agregar listeners para este evento para un manejo óptimo de los errores.

📜 Licencia

Este proyecto está bajo la Licencia MIT. Consulta el archivo LICENSE para más detalles.

📞 Contacto

Si tienes preguntas, comentarios o te gustaría colaborar en el proyecto, no dudes en enviarnos un email a [email protected].