Sdk types

Tabla de contenidos

• Introducción
• Instalación
• Cómo contribuir

Introducción

Tal como indica la documentación: devDocs, la variable global avt, accesible dentro del entorno de las extensiones, cuenta con varios módulos.

Este repositorio almacena la declaración de tipos de estos para simplificar el desarrollo, haciendo que este sea más ágil y rápido.

Instalación

Este repositorio puede ser instalado como una dependencia npm. Se recomienda instalarlo como 'dependencia de desarrollo' (dentro de devDependencies en el package.json).

Desde la consola, en el root del proyecto, correr:

npm install -D @auravant/sdk-types

Cómo contribuir

El repositorio se encuentra ordenado según carpetas. Dentro de estas carpetas se encuentran las declaraciones de cada módulo de la variable global avt. En caso de identificar que una función del SDK no tiene las declaraciones correctas en el paquete:

1. Clonar el repo
2. Crear una branch neuva con el nombre de la función a agregar/actualizar
3. Hacer un git checkout a esa branch
4. Buscar la carpeta del módulo al cual pertenece la función y hacer los cambios (typescript)
5. Pushear la branch al repositorio remoto
6. Levantar un merge request desde gitlab hacia la branch main directamente

Nota: Es posible que haya que actualizar el paquete de npm manualmente (en caso que CICD no esté configurado todavía). Con dejar el merge request abierto basta. Sino, dar aviso de la actualización