@denevads/dnv-smo 1.0.12 → 1.0.14

package/README.md

@@ -1,20 +1,80 @@
 #Introducción 
-TODO: Proporcione una breve introducción del proyecto. En esta sección se deben explicar los objetivos o los motivos del proyecto. 
+Librería de interfaz de comunicaciones entre un objeto HTML5 y las funciones de un player de DenevaDS.
 
-# Tareas iniciales
-TODO: Guíe a los usuarios para que apliquen el código a su sistema propio sin ningún problema. En esta sección se puede hablar sobre:
-1.	El proceso de instalación
-2.	Las dependencias de software
-3.	Las últimas versiones
-4.	Las referencias de API
+Aquí definiremos el uso de la librería y las funciones que la misma provee
 
-# Compilación y prueba
-TODO: Describa y muestre cómo compilar el código y ejecutar las pruebas. 
 
-# Contribución
-TODO: Explique cómo pueden contribuir otros usuarios y desarrolladores a la mejora del código. 
+# 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
+```
 
-Si quiere obtener más información sobre cómo crear archivos Léame descriptivos, consulte las siguientes [directrices](https://docs.microsoft.com/en-us/azure/devops/repos/git/create-a-readme?view=azure-devops). También puede inspirarse en los archivos Léame siguientes:
-- [ASP.NET Core](https://github.com/aspnet/Home)
-- [Visual Studio Code](https://github.com/Microsoft/vscode)
-- [Chakra Core](https://github.com/Microsoft/ChakraCore)
+# Inicialización
+
+Una vez que tengamos el proyecto de angular inicializado, procedemos importar el módulo.
+
+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]
+```
+
+Ahora ya solo bastaría con añadirlo al componente del angular y empezar a usarlo.
+
+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/index.d.ts

@@ -1 +1 @@
-export * from "./";
+export * from "./";

package/dist/index.js

@@ -1,17 +1,17 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./"), exports);

package/dist/interfaces/callbacks.d.ts

@@ -1,56 +1,56 @@
-export interface setDatasource {
-    xml: string;
-}
-export interface start {
-}
-export interface variable {
-    variable: string;
-    valor: string;
-}
-export interface location {
-    top: string;
-    left: string;
-    width: string;
-    height: string;
-}
-export interface Slide {
-    codigo: string;
-    idioma: string;
-    denominacion: string;
-    hash: string;
-}
-export interface DataSalida {
-    dataKey: string;
-    data: Slide[];
-}
-export interface ExecFunction {
-    funcion: string;
-    params: string;
-}
-export interface Notify {
-    destion: string;
-    value: any;
-}
-export interface GetRecursos {
-    codigo: number;
-    fechaInicio: string;
-    fechaFin: string;
-    recursos: Recurso[];
-}
-export interface GetRecursosRelleno {
-    codigo: number;
-    recursos: Recurso[];
-}
-export interface Recurso {
-    codigo: number;
-    url: string;
-    duracion: number;
-    tipo: number;
-    disponible: boolean;
-    vigencia_inicio: string;
-    vigencia_fin: string;
-    hora_inicio: string;
-    hora_fin: string;
-    dias: string;
-    nombre: string;
-}
+export interface setDatasource {
+    xml: string;
+}
+export interface start {
+}
+export interface variable {
+    variable: string;
+    valor: string;
+}
+export interface location {
+    top: string;
+    left: string;
+    width: string;
+    height: string;
+}
+export interface Slide {
+    codigo: string;
+    idioma: string;
+    denominacion: string;
+    hash: string;
+}
+export interface DataSalida {
+    dataKey: string;
+    data: Slide[];
+}
+export interface ExecFunction {
+    funcion: string;
+    params: string;
+}
+export interface Notify {
+    destion: string;
+    value: any;
+}
+export interface GetRecursos {
+    codigo: number;
+    fechaInicio: string;
+    fechaFin: string;
+    recursos: Recurso[];
+}
+export interface GetRecursosRelleno {
+    codigo: number;
+    recursos: Recurso[];
+}
+export interface Recurso {
+    codigo: number;
+    url: string;
+    duracion: number;
+    tipo: number;
+    disponible: boolean;
+    vigencia_inicio: string;
+    vigencia_fin: string;
+    hora_inicio: string;
+    hora_fin: string;
+    dias: string;
+    nombre: string;
+}

package/dist/interfaces/callbacks.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/smo.d.ts

@@ -1,117 +1,125 @@
-import { setDatasource, variable, location, DataSalida, ExecFunction, Notify, start, GetRecursos, GetRecursosRelleno } from "./interfaces/callbacks";
-import { Subject } from 'rxjs';
-export declare class SMO {
-    vars: any;
-    id: string;
-    private intervalsubscriptionDataSource;
-    intervalDataSource$: import("rxjs").Observable<number>;
-    smoCallBacks: smoCallBacks;
-    utils: Utils;
-    events: SmoEvents;
-    constructor();
-    init(): void;
-    initOnMessage(): void;
-    start(): void;
-    setDatasource(datasource: setDatasource): void;
-    getVariable(variable: variable): void;
-    setCurrentStream(stream: string): void;
-    infoCurrentLocation(location: location): void;
-    setSalidaData(data: DataSalida): void;
-    updatefromsalida(data: any): void;
-    getRecursos(data: GetRecursos): void;
-    getRecursosDefault(data: GetRecursos): void;
-    getRecursosRelleno(data: GetRecursosRelleno): void;
-    getVariableStorage(variable: variable): void;
-}
-declare class SmoEvents {
-    start: Subject<start>;
-    setDatasource: Subject<setDatasource>;
-    setDatasourceJson: Subject<any>;
-    getVariable: Subject<variable>;
-    setCurrentStream: Subject<string>;
-    infoCurrentLocation: Subject<location>;
-    setSalidaData: Subject<DataSalida>;
-    updatefromsalida: Subject<any>;
-    getRecursos: Subject<GetRecursos>;
-    getRecursosDefault: Subject<GetRecursos>;
-    getRecursosRelleno: Subject<GetRecursosRelleno>;
-    getVariableStorage: Subject<variable>;
-    constructor(smo: SMO);
-}
-declare class smoCallBacks {
-    smo: SMO;
-    constructor(_smo: SMO);
-    onSmoLoad(): void;
-    onSmoReady(): void;
-    smoLog(msn: string, level: LogLevel): void;
-    smoAlarma(msn: string, level: AlarmaLevel): void;
-    smoLogStash(msn: string): void;
-    smoLogNowShowing(msn: any): void;
-    reiniciarDispositivo(msn: string): void;
-    urlNext(): void;
-    exitInteractivity(): void;
-    showBrowser(): void;
-    closeBrowser(): void;
-    urlNextDirectamente(): void;
-    setVariable(variable: string, valor: string): void;
-    getVariable(variable: string): void;
-    getFile(file: string): void;
-    setLocalData(variable: string, valor: string): void;
-    getLocalData(variable: string): void;
-    getCurrentStream(): void;
-    finAviso(id: string): void;
-    refreshDatasource(codigo: string): void;
-    getLocation(): void;
-    getSalidaData(data: string): void;
-    ejecutaFuncion(data: ExecFunction): void;
-    addObserver(data: string): void;
-    notify(data: Notify): void;
-    playOnceChannelByTrigger(trigger: string): void;
-    stopPlayOnceChannelByTrigger(): void;
-    playOnceChannel(codigoCanal: string): void;
-    stopPlayChannel(): void;
-    editWrapperStyle(obj: any): void;
-    getRecursos(): void;
-    getRecursosDefault(): void;
-    getRecursosRelleno(): void;
-    setVariableStorage(variable: string, valor: string): void;
-    getVariableStorage(variable: string): void;
-}
-declare class Utils {
-    smo: SMO;
-    smoCallBacks: smoCallBacks;
-    constructor(_smo: SMO, _smoCallBacks: smoCallBacks);
-    xmlToJSON(xml: string): string;
-    jsonToStr(js_obj: any): string;
-    setJsonObj(xml: any): any;
-    dataToJSON(data: setDatasource): any;
-}
-export declare enum SMO_EVENT_TYPE {
-    start = "start",
-    setDatasource = "setDatasource",
-    getVariable = "getVariable",
-    setCurrentStream = "setCurrentStream",
-    infoCurrentLocation = "infoCurrentLocation",
-    setSalidaData = "setSalidaData",
-    updatefromsalida = "updatefromsalida",
-    setDatasourceJson = "setDatasourceJson",
-    getRecursos = "getRecursos",
-    getRecursosDefault = "getRecursosDefault",
-    getRecursosRelleno = "getRecursosRelleno",
-    getVariableStorage = "getVariableStorage"
-}
-export declare enum LogLevel {
-    Debug = 0,
-    Info = 1,
-    Warning = 2,
-    Error = 3
-}
-export declare enum AlarmaLevel {
-    Ok_off = 0,
-    Ok = 1,
-    Scanning = 2,
-    Timeout = 3,
-    Warning = 4,
-    Error = 5
-}
-export {};
+import { setDatasource, variable, location, DataSalida, ExecFunction, Notify, start, GetRecursos, GetRecursosRelleno } from "./interfaces/callbacks";
+import { Subject } from 'rxjs';
+export declare class SMO {
+    vars: any;
+    id: string;
+    private intervalsubscriptionDataSource;
+    intervalDataSource$: import("rxjs").Observable<number>;
+    smoCallBacks: smoCallBacks;
+    utils: Utils;
+    events: SmoEvents;
+    constructor();
+    init(): void;
+    initOnMessage(): void;
+    start(): void;
+    setDatasource(datasource: setDatasource): void;
+    getVariable(variable: variable): void;
+    setCurrentStream(stream: string): void;
+    infoCurrentLocation(location: location): void;
+    setSalidaData(data: DataSalida): void;
+    updatefromsalida(data: any): void;
+    getRecursos(data: GetRecursos): void;
+    getRecursosDefault(data: GetRecursos): void;
+    getRecursosRelleno(data: GetRecursosRelleno): void;
+    getVariableStorage(variable: variable): void;
+    checkHealth(variable: string): void;
+}
+declare class SmoEvents {
+    start: Subject<start>;
+    setDatasource: Subject<setDatasource>;
+    setDatasourceJson: Subject<any>;
+    getVariable: Subject<variable>;
+    setCurrentStream: Subject<string>;
+    infoCurrentLocation: Subject<location>;
+    setSalidaData: Subject<DataSalida>;
+    updatefromsalida: Subject<any>;
+    getRecursos: Subject<GetRecursos>;
+    getRecursosDefault: Subject<GetRecursos>;
+    getRecursosRelleno: Subject<GetRecursosRelleno>;
+    getVariableStorage: Subject<variable>;
+    checkHealth: Subject<string>;
+    constructor(smo: SMO);
+}
+declare class smoCallBacks {
+    smo: SMO;
+    constructor(_smo: SMO);
+    onSmoLoad(): void;
+    onSmoReady(): void;
+    smoLog(msn: string, level: LogLevel): void;
+    smoAlarma(msn: string, level: AlarmaLevel): void;
+    smoLogStash(msn: string): void;
+    smoLogNowShowing(msn: any): void;
+    reiniciarDispositivo(msn: string): void;
+    urlNext(): void;
+    exitInteractivity(): void;
+    showBrowser(): void;
+    closeBrowser(): void;
+    urlNextDirectamente(): void;
+    setVariable(variable: string, valor: string): void;
+    getVariable(variable: string): void;
+    getFile(file: string): void;
+    setLocalData(variable: string, valor: string): void;
+    getLocalData(variable: string): void;
+    getCurrentStream(): void;
+    finAviso(id: string): void;
+    refreshDatasource(codigo: string): void;
+    getLocation(): void;
+    getSalidaData(data: string): void;
+    ejecutaFuncion(data: ExecFunction): void;
+    addObserver(data: string): void;
+    notify(data: Notify): void;
+    playOnceChannelByTrigger(trigger: string): void;
+    stopPlayOnceChannelByTrigger(): void;
+    playOnceChannel(codigoCanal: string): void;
+    stopPlayChannel(): void;
+    editWrapperStyle(obj: any): void;
+    getRecursos(): void;
+    getRecursosDefault(): void;
+    getRecursosRelleno(): void;
+    setVariableStorage(variable: string, valor: string): void;
+    getVariableStorage(variable: string): void;
+    printTextLine(txt: string): void;
+    printBarcode(code: string, width: number, height: number): void;
+    cutPaper(percent: number): void;
+    checkHealth(): void;
+    printImage(image: string): void;
+}
+declare class Utils {
+    smo: SMO;
+    smoCallBacks: smoCallBacks;
+    constructor(_smo: SMO, _smoCallBacks: smoCallBacks);
+    xmlToJSON(xml: string): string;
+    jsonToStr(js_obj: any): string;
+    setJsonObj(xml: any): any;
+    dataToJSON(data: setDatasource): any;
+}
+export declare enum SMO_EVENT_TYPE {
+    start = "start",
+    setDatasource = "setDatasource",
+    getVariable = "getVariable",
+    setCurrentStream = "setCurrentStream",
+    infoCurrentLocation = "infoCurrentLocation",
+    setSalidaData = "setSalidaData",
+    updatefromsalida = "updatefromsalida",
+    setDatasourceJson = "setDatasourceJson",
+    getRecursos = "getRecursos",
+    getRecursosDefault = "getRecursosDefault",
+    getRecursosRelleno = "getRecursosRelleno",
+    getVariableStorage = "getVariableStorage",
+    checkHealth = "checkHealth"
+}
+export declare enum LogLevel {
+    Debug = 0,
+    Info = 1,
+    Warning = 2,
+    Error = 3
+}
+export declare enum AlarmaLevel {
+    Ok_off = 0,
+    Ok = 1,
+    Scanning = 2,
+    Timeout = 3,
+    Warning = 4,
+    Error = 5
+}
+export {};