npm package: @hcd-bsas/list-documents-adapter
Description: ## Estructura del proyecto
Latest version: 0.0.9


# js-plugin

## Estructura del proyecto

Genera una librería javascript que funciona como "adapter" del plugin generado con vue-cli-plugin, la cual permite que se lo pueda utilizar desde cualquier entorno javascript sin necesidad de que el proyecto sea Vue 3.

Internamente la librería exporta una app de Vue 3 que usa el Plugin **list-documents-plugin**.

## Pre-requisitos

### Es necesario tener instalado

* [Node Js LTS](https://nodejs.org/en/) La versión utilizada para el primer desarrollo fue 16.14.0 LTS.
* [yarn](https://yarnpkg.com/) 

    ~~~ 
    npm install -g yarn
    ~~~

### Recomendaciones opcionales para instalar

* [Visual Studio Code](https://code.visualstudio.com/)
* [CMDER](https://github.com/cmderdev/cmder) es una consola de comandos sencilla con algunas sintaxis linux

## Instalación

El proyecto javascript esta armado con [webpack](https://webpack.js.org/concepts/) y algunas librerías adicionales. 

Su instalación es sencilla ejecutando en la raíz del directorio el comando **install** que agregara todas las dependencias necesarias:

~~~
    yarn install
~~~

## Compilación desarrollo

El comando **serve** compila el proyecto y se lu puede probar desde el test_javascript.html:

~~~
    yarn serve
~~~

## Compilación productiva y publicación en NPM

### Compilación producción

El comando **build** compila el proyecto comprimido para luego poder ser distribuido.

~~~
    yarn build
~~~

### Publicación NPM

Posteriormente para poder publicar la librería en [NPM](https://www.npmjs.com/) se debe:

1) Tener un usuario registrado. [Ir al registro...](https://www.npmjs.com/signup)

2) Acceder a la cuenta de NPM de la HDC desde el navegador y agregar como administrador al usuario registrado en la organización **@hcd-bsas**. Credenciales: 

    > Usuario: desarrollohcd

    > Contraseña:  "la misma que se utiliza en el correo hcddesarrolladoras@gmail.com"

3) Autenticar con el usuario registrado en el paso 1 desde la linea de comandos

~~~
    yarn login
~~~

4) Asegurase de previamente haber compilado la librería en modo producción (comando **build**).

5) Publicar librería con el comando **publish**, el cual preguntara cual es el nuevo número de versión. En donde "version": *.*.* --> El primer número corresponde a cambios grandes, el segundo nuevas funcionalidades y el tercero corrección de errores o cambios menores.

~~~
    yarn publish
~~~

Nota: En ocasiones da el error "You cannot publish over the previously published versions" al no poder cambiar la versión de la librería desde la linea de comandos. Para ello se debe aumentar el número de versión en la opción **version** del package.json

### Como hacer uso de la librería con NPM

Pero para poder instalar la librería en cualquier otro proyecto se debe correr el comando en el directorio donde el proyecto contenga las librerías javascript.

~~~
    yarn add @hcd-bsas/list-documents-adapter
~~~

Luego se debe indicar en el constructor la url base donde se encuentran los endpoint para obtener la información a visualizar.

~~~
    var list = new ImagesList({
        base_url: "http://localhost/admin",
    });
~~~

A partir de la instancia creada se puede invocar al método **open** que recibe 2 parámetros, las opciones de configuración de la app y los parámetros a pasar al endpoint que recupera el listado. 

Por otro lado el método **open** retorna una promesa que indica cuando el plugin finalizo y esta visible.

~~~
    list.open({
        title: "Listado de imágenes escaneadas en Rhys"
    },{
        id_tabla: ****,
        id_tabla_reg: ****,
        id_dependen_responsable: ****,
        id_pers_reso: ****,
        campo_escan: ****
    }).then((response) => {
        console.log(response)
    });
~~~

Nota: Se puede ver un ejemplo funcional completo en el archivo test_javascript.html