architecture-it/sdk-bridge ¶

Biblioteca de utilidades para integración de SDK's en Aplicaciones React Native.

Se proporcionan un conjunto de funciones y utilidades diseñadas para facilitar la integración entre aplicaciones desarrolladas en React Native y diversos SDK. Su objetivo es actuar como un puente eficiente, permitiendo una comunicación y funcionalidad optimizada entre la aplicación y los SDK utilizados.

Requisitos previos¶

Para poder utilizar la librería el valor de minSdkVersion mínino debe ser 24.

Instalación¶

yarn add @architecture-it/sdk-bridge

Configuración¶

Para poder consumir la librería correctamente es necesario realizar algunas configuraciones y setear las credenciales de acceso al SDK de distribución en el sistema.

Acceder al archivo build.gradle que se encuentra en el directorio android/app/build.gradle.

En la sección dependencies se deberá agregar la implementación del SDK:

dependencies {
    implementation("com.store-distribution:sdk:1.0.1")

    ... // other implementations
}

Tener en consideración que se deberá agregar la implementación con la versión correspondiente del SDK que consuma la versión de la librería que se esté instalando. En la sección del final se listará la versión de SDK que utiliza cada versión de esta librería.

En la sección repositories las credenciales de Maven:

repositories {
    maven {
        name "GitHubPackages"
        url "https://maven.pkg.github.com/architecture-it/store-distribution-sdk"
        credentials {
            username System.getenv("MAVEN_USER")
            password System.getenv("MAVEN_PASSWORD")
        }
    }
}

A nivel sistema se deberán configurar y agregar las variables de entorno que se necesitan que son: MAVEN_USER y MAVEN_PASSWORD.

En windows

setx MAVEN_USER "maven_user"
setx MAVEN_PASSWORD "maven_password"

Solicitar los valores de las credenciales al equipo de arquitectura.

Utilización¶

useDistributionSDK();¶

La librería exporta un hook que es el que consume internamente el módulo nativo que funciona como bridge con el SDK de distribución.

Para implementarlo, es necesario pasarle como parámetro el email del usuario:

useDistributionSDK({ email: "example@gmail.com" });

Breaking change V1.1.0¶

A partir de la v1.1.0, la implementación de este hook se modifica, en su funcionamiento y en el listado de parámetros que se le puede pasar:

Se implementa la posibilidad de poder cargar la alerta de actualización de forma constante (valor por default), lo que permitirá que se renderice la misma cada vez que se ingresa a la pantalla en donde se colocó el hook (por ejemplo la pantalla de Inicio). Esto hará que, si la actualización es forzada (se requiere que el usuario actualice si o sí) no se pueda cerrar la alerta y continuar trabajando.

Este comportamiento se puede modificar seteando el parámetro displayRepeatedly en false. Sin embargo, se reitera que de desactivar esta opción, la alerta sólo volverá a aparecer cuando se cargue nuevamente la aplicación.

También se agregaron dos variables opcionales para poder dejar registrado más datos del usuario logueado en la aplicación: name y lastName.

Versiones¶

Cómo se comentó previamente, esta librería hace uso del SDK de distribución, para su implementación puede ser que diferentes versiones de la librería consuman diferentes versiones del SDK. Para ello, se debe revisar en este listado que versión del SDK se debe configurar:

Versión librería | Versión SDK

1.0.2 | 1.0.1
1.0.6 | 1.0.5
1.1.0 | 1.0.7

architecture-it/sdk-bridge¶