Saltar al contenido principal

Introducción al SDK

Tu Extensión necesita interactuar con todos los componentes que hay en la plataforma, como puede ser el menú lateral, el selector inferior de imágenes, avisos, modales, etc. Para cumplir con esta función proveemos un SDK para Javascript que te permitirá hacerlo.

En pocas palabras el SDK provee un mecanismo para que puedas realizar operaciones sobre la interfaz principal de la plataforma, ya sea su versión web como móvil. Por otra parte también envuelve (hace de Wrap) funciones de uso común de nuestras APIs, haciendo que llamarlas sea mucho más sencillo.

Incluir el SDK en tu código​

Para incluir el SDK en tu código simplemente tienes que agregar el script público de aura-package en tu archivo HTML. Procura siempre utilizar la última versión disponible!

  <script src="https://auraview.auravant.com/sdk/v1.0/aura-package_v1.0.js"></script>

Organización de las funciones​

Todas las funciones del SDK serán accesibles a través del namespace avt. Dentro de ese espacio hay distintos módulos y dentro de cada módulo encontrás las funciones. Por ejemplo si quisiéramos ejecutar la función 'hiAuravant()' del módulo 'test' debemos llamar a avt.test.hiAuravant()

Funciones sincrónicas y asincrónicas​

Una nota importante antes de empezar. Dentro de las funciones disponibles veras que todas tienen una versión asincrónica (te darás cuenta dado que tienen 'async' en su nombre) como en algunos casos habrá disponible versiones sincrónicas. Es importante mencionar que recomendamos siempre usar las versiones asincrónicas que retornan una promesa.

SDK en el desarrollo​

Para hacer tu vida más sencilla, desarrollamos el paquete @auravant/sdk-types para que puedas instalar desde npm como dependencia de desarrollo y así poder acceder a los módulos y funciones rápidamente desde la IDE. Además, en caso de usar TypeScript, esto solucionará los posibles errores de la IDE correspondientes a que no están declaradas las variables.

Recomendamos instalarlo como dependencia de desarrollo. Es decir, agregarlo a devDependencies dentro del package.json de tu proyecto, o correr en la terminal (dentro de tu proyecto):

npm install -D @auravant/sdk-types

En caso de estar usando TypeScript para tu extensión, es posible que tengas que agregar "types": ["./node_modules/@auravant/sdk-types"] dentro de compilerOptions en el archivo tsconfig.json.