@denevads/dnv-smo 1.0.20 → 1.0.21

package/README.md

@@ -1,18 +1,80 @@
-# DnvSMO
-Libreria de conexión con la API de la salida.
+#Introducción 
+Librería de interfaz de comunicaciones entre un objeto HTML5 y las funciones de un player de DenevaDS.
 
-## Conexión con NPM 
+Aquí definiremos el uso de la librería y las funciones que la misma provee
 
-Para conexión con NPM se deben de ejecutar los siguientes comandos. La cuenta de login es denevads
 
+# Instalación
+La librería esta pensada para ser usada junto con Angular, de manera que si no contamos con el cli de angular en el sistema conviene instalarlo para inicializar el proyecto.
+```sh
+npm install -g @angular/cli
+```
+Inicializamos un proyecto de prueba llamado html-deneva en la ruta en la que estemos.
+```sh
+ng new html-deneva
+```
+Una vez que ya tenemos la estructura básica del proyecto podemos instalar la librería en el proyecto ejecutando la siguiente liena dentro de la carpeta del mismo:
+```sh
+npm install @denevads/dnv-smo
+```
 
-npm run build
+# Inicialización
 
-npm login
+Una vez que tengamos el proyecto de angular inicializado, procedemos importar el módulo.
 
-npm publish
+Dentro de la definición del app.module en la carpeta app, importamos la librería.
+```ts
+ import { SMO } from '@denevads/dnv-smo/dist/smo'; 
+```
+y lo añadimos como provider en @NgModule
+```ts
+providers: [SMO]
+```
 
-## Instalación.
+Ahora ya solo bastaría con añadirlo al componente del angular y empezar a usarlo.
 
-Para instalar la librería hay que ejecutar: npm install @denevads/dnv-smo
+De nuevo en app.component importamos la librería
+```js
+import { LogLevel, SMO } from '@denevads/dnv-smo/dist/smo'
+```
+Y en la exportación de la clase AppComponent añadimos el constructor
+```js
+constructor(private smo:SMO){ }
+```
+De esta manera ya tendríamos disponible para su uso todas las llamadas que aporta la librería usando 
+```js
+this.smo.
+```
+También en la importacion hemos traído la enumeración de los niveles de log, que sirven para loggear en el disco del equipo.
+El uso sería de la siguiente forma.
+```js
+this.smo.smoCallBacks.smoLog('Mensaje de prueba',LogLevel.Info);
+```
 
+# Compilación y empaquetado.
+
+Para que el proyecto pueda funcionar en un equipo sin problemas hay que hacer un par de cambios en el código del proyecto por defecto.
+
+El primero de ellos es modificar el tsconfig.json para que el "target" sea "ES5" en lugar de "ES2022"
+
+
+Y el segundo cambio es en archivo de index. Aquí haremos dos cosas. 
+-Borraremos la importación del favicon (además de borrarlo de la carpeta de archivos).
+-Y cambiamos la línea
+```html
+<base href="/"> 
+```
+por 
+```html
+<script>document.write('<base href="' + document.location + '" />');</script>
+```
+Con estos cambios hechos, podemos compilar el proyecto ejecutando la línea
+```sh
+ng b
+```
+Esto nos generara una carpeta dist, con el contenido de nuestro HTML5 compilado.
+
+Para poder subirlo al player de deneva, simplemente tenemos que crear un zip con el contenido en la raíz, y le cambiaremos la extensión por 
+```sh
+.wgt
+```

package/dist/smo.d.ts

@@ -108,7 +108,7 @@ export declare enum SMO_EVENT_TYPE {
     setSalidaData = "setSalidaData",
     updatefromsalida = "updatefromsalida",
     setDatasourceJson = "setDatasourceJson",
-    getRecursosByCodigo = "getRecursosBycodigo",
+    getRecursosByCodigo = "getRecursosByCodigo",
     getRecursos = "getRecursos",
     getRecursosDefault = "getRecursosDefault",
     getRecursosRelleno = "getRecursosRelleno",

package/dist/smo.js

@@ -716,7 +716,7 @@ var SMO_EVENT_TYPE;
     SMO_EVENT_TYPE["setSalidaData"] = "setSalidaData";
     SMO_EVENT_TYPE["updatefromsalida"] = "updatefromsalida";
     SMO_EVENT_TYPE["setDatasourceJson"] = "setDatasourceJson";
-    SMO_EVENT_TYPE["getRecursosByCodigo"] = "getRecursosBycodigo";
+    SMO_EVENT_TYPE["getRecursosByCodigo"] = "getRecursosByCodigo";
     SMO_EVENT_TYPE["getRecursos"] = "getRecursos";
     SMO_EVENT_TYPE["getRecursosDefault"] = "getRecursosDefault";
     SMO_EVENT_TYPE["getRecursosRelleno"] = "getRecursosRelleno";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@denevads/dnv-smo",
-    "version": "1.0.20",
+    "version": "1.0.21",
     "description": "SMO module",
     "main": "./src/index.js",
     "types": "./src/index.d.ts",

package/src/smo.ts

@@ -758,7 +758,7 @@ export enum SMO_EVENT_TYPE{
     setSalidaData ="setSalidaData",
     updatefromsalida = "updatefromsalida",
     setDatasourceJson = "setDatasourceJson",
-    getRecursosByCodigo = "getRecursosBycodigo",
+    getRecursosByCodigo = "getRecursosByCodigo",
     getRecursos = "getRecursos",
     getRecursosDefault = "getRecursosDefault",
     getRecursosRelleno = "getRecursosRelleno",