@denevads/dnv-smo 1.0.19 → 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/interfaces/callbacks.d.ts

@@ -31,6 +31,9 @@ export interface Notify {
     destion: string;
     value: any;
 }
+export interface GetRecursosByCodigo {
+    recursos?: Recurso[];
+}
 export interface GetRecursos {
     codigo: number;
     fechaInicio: string;

package/dist/smo.d.ts

@@ -1,4 +1,4 @@
-import { setDatasource, variable, location, DataSalida, ExecFunction, Notify, start, GetRecursos, GetRecursosRelleno } from "./interfaces/callbacks";
+import { setDatasource, variable, location, DataSalida, ExecFunction, Notify, start, GetRecursosByCodigo, GetRecursos, GetRecursosRelleno } from "./interfaces/callbacks";
 import { Subject } from 'rxjs';
 export declare class SMO {
     vars: any;
@@ -18,6 +18,7 @@ export declare class SMO {
     infoCurrentLocation(location: location): void;
     setSalidaData(data: DataSalida): void;
     updatefromsalida(data: any): void;
+    getRecursosByCodigo(data: GetRecursosByCodigo): void;
     getRecursos(data: GetRecursos): void;
     getRecursosDefault(data: GetRecursos): void;
     getRecursosRelleno(data: GetRecursosRelleno): void;
@@ -34,6 +35,7 @@ declare class SmoEvents {
     infoCurrentLocation: Subject<location>;
     setSalidaData: Subject<DataSalida>;
     updatefromsalida: Subject<any>;
+    getRecursosByCodigo: Subject<GetRecursosByCodigo>;
     getRecursos: Subject<GetRecursos>;
     getRecursosDefault: Subject<GetRecursos>;
     getRecursosRelleno: Subject<GetRecursosRelleno>;
@@ -75,6 +77,7 @@ declare class smoCallBacks {
     playOnceChannel(codigoCanal: string): void;
     stopPlayChannel(): void;
     editWrapperStyle(obj: any): void;
+    getRecursosByCodigo(codigos: any): void;
     getRecursos(): void;
     getRecursosDefault(): void;
     getRecursosRelleno(): void;
@@ -105,6 +108,7 @@ export declare enum SMO_EVENT_TYPE {
     setSalidaData = "setSalidaData",
     updatefromsalida = "updatefromsalida",
     setDatasourceJson = "setDatasourceJson",
+    getRecursosByCodigo = "getRecursosByCodigo",
     getRecursos = "getRecursos",
     getRecursosDefault = "getRecursosDefault",
     getRecursosRelleno = "getRecursosRelleno",

package/dist/smo.js

@@ -195,6 +195,10 @@ var SMO = /** @class */ (function () {
                     selft.updatefromsalida(e.data.objdata);
                     return;
                 }
+                if (func == SMO_EVENT_TYPE.getRecursosByCodigo) {
+                    selft.getRecursosByCodigo(e.data.objData);
+                    return;
+                }
                 if (func == SMO_EVENT_TYPE.getRecursos) {
                     selft.getRecursos(e.data.objData);
                 }
@@ -243,6 +247,9 @@ var SMO = /** @class */ (function () {
     SMO.prototype.updatefromsalida = function (data) {
         this.events.updatefromsalida.next(data);
     };
+    SMO.prototype.getRecursosByCodigo = function (data) {
+        this.events.getRecursosByCodigo.next(data);
+    };
     SMO.prototype.getRecursos = function (data) {
         this.events.getRecursos.next(data);
     };
@@ -274,6 +281,7 @@ var SmoEvents = /** @class */ (function () {
         this.infoCurrentLocation = new rxjs_1.Subject();
         this.setSalidaData = new rxjs_1.Subject();
         this.updatefromsalida = new rxjs_1.Subject();
+        this.getRecursosByCodigo = new rxjs_1.Subject();
         this.getRecursos = new rxjs_1.Subject();
         this.getRecursosDefault = new rxjs_1.Subject();
         this.getRecursosRelleno = new rxjs_1.Subject();
@@ -528,6 +536,16 @@ var smoCallBacks = /** @class */ (function () {
             idSmo: this.smo.id
         }, "*");
     };
+    smoCallBacks.prototype.getRecursosByCodigo = function (codigos) {
+        /** ["123456","654321"] */
+        parent.postMessage({
+            target: "Dnv.smoCallbacks.getRecursosByCodigo",
+            objData: {
+                recursos: codigos
+            },
+            idSmo: this.smo.id
+        }, "*");
+    };
     smoCallBacks.prototype.getRecursos = function () {
         parent.postMessage({
             target: "Dnv.smoCallbacks.getRecursos",
@@ -698,6 +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["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.19",
+    "version": "1.0.21",
     "description": "SMO module",
     "main": "./src/index.js",
     "types": "./src/index.d.ts",

package/src/interfaces/callbacks.ts

@@ -34,6 +34,9 @@ export interface Notify{
     destion:string,
     value:any
 }
+export interface GetRecursosByCodigo {
+    recursos?: Recurso[];
+}
 
 export interface GetRecursos {
     codigo: number;

package/src/smo.ts

@@ -6,7 +6,9 @@ import {
     ExecFunction,
     Notify,
     start,
-    GetRecursos, GetRecursosRelleno
+    GetRecursosByCodigo,
+    GetRecursos,
+    GetRecursosRelleno
 } from "./interfaces/callbacks";
 import {interval, Subject, Subscription} from 'rxjs';
 interface Window {
@@ -222,6 +224,10 @@ export  class SMO  {
                 selft.updatefromsalida(e.data.objdata);
                 return;
             }
+            if(func == SMO_EVENT_TYPE.getRecursosByCodigo){
+                selft.getRecursosByCodigo(e.data.objData);
+                return;
+            }
             if(func == SMO_EVENT_TYPE.getRecursos){
                 selft.getRecursos(e.data.objData);
             }
@@ -271,6 +277,9 @@ export  class SMO  {
     updatefromsalida(data:any):void{
         this.events.updatefromsalida.next(data);
     }
+    getRecursosByCodigo(data:GetRecursosByCodigo):void{
+        this.events.getRecursosByCodigo.next(data);
+    }
     getRecursos(data:GetRecursos):void{
         this.events.getRecursos.next(data);
     }
@@ -300,6 +309,7 @@ class SmoEvents{
     public infoCurrentLocation: Subject<location> = new Subject<location>();
     public setSalidaData: Subject<DataSalida> = new Subject<DataSalida>();
     public updatefromsalida: Subject<any> = new Subject<any>();
+    public getRecursosByCodigo: Subject<GetRecursosByCodigo> = new Subject<GetRecursosByCodigo>();
     public getRecursos: Subject<GetRecursos> = new Subject<GetRecursos>();
     public getRecursosDefault: Subject<GetRecursos> = new Subject<GetRecursos>();
     public getRecursosRelleno: Subject<GetRecursosRelleno> = new Subject<GetRecursosRelleno>();
@@ -557,6 +567,16 @@ class smoCallBacks{
             idSmo: this.smo.id
         }, "*");
     }
+    getRecursosByCodigo(codigos: any):void{
+        /** ["123456","654321"] */
+        parent.postMessage({
+            target: "Dnv.smoCallbacks.getRecursosByCodigo",
+            objData: {
+                recursos : codigos
+            },
+            idSmo: this.smo.id
+        }, "*");
+    }
     getRecursos():void{
         parent.postMessage({
             target: "Dnv.smoCallbacks.getRecursos",
@@ -738,6 +758,7 @@ export enum SMO_EVENT_TYPE{
     setSalidaData ="setSalidaData",
     updatefromsalida = "updatefromsalida",
     setDatasourceJson = "setDatasourceJson",
+    getRecursosByCodigo = "getRecursosByCodigo",
     getRecursos = "getRecursos",
     getRecursosDefault = "getRecursosDefault",
     getRecursosRelleno = "getRecursosRelleno",