@xibosignage/xibo-layout-renderer 1.0.9 → 1.0.11

package/dist/src/Types/Layout/Layout.types.d.ts

@@ -31,6 +31,7 @@ export type OptionsType = {
 export interface ILayout {
     id: number | null;
     layoutId: number | null;
+    scheduleId?: number;
     sw: number | null;
     sh: number | null;
     xw: number | null;
@@ -69,6 +70,7 @@ export interface ILayout {
     resetLayout(): Promise<void>;
     index: number;
     actionController: InteractiveActions | undefined;
+    enableStat: boolean;
 }
 export declare const initialLayout: ILayout;
 export type GetLayoutParamType = {

package/dist/src/Types/Media/Media.types.d.ts

@@ -41,5 +41,6 @@ export interface IMedia {
     region: IRegion;
     fileId: string;
     emitter: Emitter<IMediaEvents>;
+    enableStat: boolean;
 }
 export declare const initialMedia: IMedia;

package/dist/xibo-layout-renderer.cjs.js

@@ -664,7 +664,8 @@ var initialLayout = {
   },
   emitter: {},
   index: -1,
-  actionController: undefined
+  actionController: undefined,
+  enableStat: false
 };
 
 function nextId(options) {
@@ -849,7 +850,9 @@ function composeMediaUrl(params) {
 function composeBgUrlByPlatform(platform, params) {
   var bgImageUrl = params.layoutBackgroundDownloadUrl.replace(":id", params.layout.id) + '?preview=1&width=' + params.layout.sWidth + '&height=' + params.layout.sHeight + '&dynamic&proportional=0';
   if (platform === 'chromeOS') {
-    bgImageUrl = '/required-files/resource/' + params.layout.id + '?saveAs=' + params.layout.bgImage;
+    bgImageUrl = composeMediaUrl({
+      uri: params.layout.bgImage
+    });
   }
   return bgImageUrl;
 }
@@ -69557,7 +69560,8 @@ var initialMedia = {
   on: function on(event, callback) {
     return {};
   },
-  emitter: {}
+  emitter: {},
+  enableStat: false
 };
 
 /*
@@ -72812,6 +72816,7 @@ function Media(region, mediaId, xml, options, xlr) {
   var mediaTimeCount = 0;
   var emitter = createNanoEvents();
   var mediaObject = _objectSpread2(_objectSpread2({}, initialMedia), props);
+  var statsBC = new BroadcastChannel('statsBC');
   var startMediaTimer = function startMediaTimer(media) {
     mediaTimer = setInterval(function () {
       mediaTimeCount++;
@@ -72835,12 +72840,32 @@ function Media(region, mediaId, xml, options, xlr) {
     } else {
       startMediaTimer(media);
     }
+    // Check if stats are enabled for the layout
+    if (media.enableStat) {
+      statsBC.postMessage({
+        action: 'START_STAT',
+        mediaId: parseInt(media.id),
+        layoutId: media.region.layout.id,
+        scheduleId: media.region.layout.scheduleId,
+        type: 'media'
+      });
+    }
   });
   emitter.on('end', function (media) {
     if (mediaTimer) {
       clearInterval(mediaTimer);
       mediaTimeCount = 0;
     }
+    // Check if stats are enabled for the layout
+    if (media.enableStat) {
+      statsBC.postMessage({
+        action: 'END_STAT',
+        mediaId: parseInt(media.id),
+        layoutId: media.region.layout.id,
+        scheduleId: media.region.layout.scheduleId,
+        type: 'media'
+      });
+    }
     media.region.playNextMedia();
   });
   mediaObject.on = function (event, callback) {
@@ -72848,7 +72873,7 @@ function Media(region, mediaId, xml, options, xlr) {
   };
   mediaObject.emitter = emitter;
   mediaObject.init = function () {
-    var _self$xml, _self$xml2, _self$xml3, _self$xml4, _self$xml5;
+    var _self$xml, _self$xml2, _self$xml3, _self$xml4, _self$xml5, _self$xml6;
     var self = mediaObject;
     self.id = props.mediaId;
     self.fileId = ((_self$xml = self.xml) === null || _self$xml === void 0 ? void 0 : _self$xml.getAttribute('fileId')) || '';
@@ -72858,9 +72883,10 @@ function Media(region, mediaId, xml, options, xlr) {
     self.mediaType = ((_self$xml2 = self.xml) === null || _self$xml2 === void 0 ? void 0 : _self$xml2.getAttribute('type')) || '';
     self.render = ((_self$xml3 = self.xml) === null || _self$xml3 === void 0 ? void 0 : _self$xml3.getAttribute('render')) || '';
     self.duration = parseInt((_self$xml4 = self.xml) === null || _self$xml4 === void 0 ? void 0 : _self$xml4.getAttribute('duration')) || 0;
+    self.enableStat = Boolean(((_self$xml5 = self.xml) === null || _self$xml5 === void 0 ? void 0 : _self$xml5.getAttribute('enableStat')) || false);
     self.options = _objectSpread2({}, props.options);
     var $mediaIframe = document.createElement('iframe');
-    var mediaOptions = (_self$xml5 = self.xml) === null || _self$xml5 === void 0 ? void 0 : _self$xml5.getElementsByTagName('options');
+    var mediaOptions = (_self$xml6 = self.xml) === null || _self$xml6 === void 0 ? void 0 : _self$xml6.getElementsByTagName('options');
     if (mediaOptions) {
       for (var _i = 0, _Array$from = Array.from(mediaOptions); _i < _Array$from.length; _i++) {
         var _options = _Array$from[_i];
@@ -73888,9 +73914,19 @@ function Layout(data, options, xlr, layout) {
     layout: layout || initialLayout
   };
   var emitter = createNanoEvents();
+  var statsBC = new BroadcastChannel('statsBC');
   emitter.on('start', function (layout) {
     layout.done = false;
     console.debug('Layout start emitted > Layout ID > ', layout.id);
+    // Check if stats are enabled for the layout
+    if (layout.enableStat) {
+      statsBC.postMessage({
+        action: 'START_STAT',
+        layoutId: layout.id,
+        scheduleId: layout.scheduleId,
+        type: 'layout'
+      });
+    }
   });
   emitter.on('end', /*#__PURE__*/function () {
     var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(layout) {
@@ -73908,13 +73944,22 @@ function Layout(data, options, xlr, layout) {
             if ($layout !== null) {
               $layout.remove();
             }
+            // Check if stats are enabled for the layout
+            if (layout.enableStat) {
+              statsBC.postMessage({
+                action: 'END_STAT',
+                layoutId: layout.id,
+                scheduleId: layout.scheduleId,
+                type: 'layout'
+              });
+            }
             if (xlr.config.platform !== 'CMS') {
               // Transition next layout to current layout and prepare next layout if exist
               xlr.prepareLayouts().then(function (parent) {
                 xlr.playSchedules(parent);
               });
             }
-          case 6:
+          case 7:
           case "end":
             return _context.stop();
         }
@@ -73952,7 +73997,7 @@ function Layout(data, options, xlr, layout) {
     layoutObject.parseXlf();
   };
   layoutObject.parseXlf = function () {
-    var _layout$layoutNode, _layout$layoutNode2, _layout$layoutNode3, _layout$layoutNode4, _layout$layoutNode5, _layout$layoutNode6, _layout$layoutNode7, _layout$layoutNode8;
+    var _layout$layoutNode, _layout$layoutNode2, _layout$layoutNode3, _layout$layoutNode4, _layout$layoutNode5, _layout$layoutNode6, _layout$layoutNode7, _layout$layoutNode8, _layout$layoutNode9;
     var layout = this;
     var options = layout.options;
     layout.done = false;
@@ -73981,6 +74026,7 @@ function Layout(data, options, xlr, layout) {
     layout.xw = Number((_layout$layoutNode = layout.layoutNode) === null || _layout$layoutNode === void 0 || (_layout$layoutNode = _layout$layoutNode.firstElementChild) === null || _layout$layoutNode === void 0 ? void 0 : _layout$layoutNode.getAttribute('width'));
     layout.xh = Number((_layout$layoutNode2 = layout.layoutNode) === null || _layout$layoutNode2 === void 0 || (_layout$layoutNode2 = _layout$layoutNode2.firstElementChild) === null || _layout$layoutNode2 === void 0 ? void 0 : _layout$layoutNode2.getAttribute('height'));
     layout.zIndex = Number((_layout$layoutNode3 = layout.layoutNode) === null || _layout$layoutNode3 === void 0 || (_layout$layoutNode3 = _layout$layoutNode3.firstElementChild) === null || _layout$layoutNode3 === void 0 ? void 0 : _layout$layoutNode3.getAttribute('zindex')) || 0;
+    layout.enableStat = Boolean(((_layout$layoutNode4 = layout.layoutNode) === null || _layout$layoutNode4 === void 0 || (_layout$layoutNode4 = _layout$layoutNode4.firstElementChild) === null || _layout$layoutNode4 === void 0 ? void 0 : _layout$layoutNode4.getAttribute('enableStat')) || false);
     /* Calculate Scale Factor */
     layout.scaleFactor = Math.min(layout.sw / layout.xw, layout.sh / layout.xh);
     layout.sWidth = layout.xw * layout.scaleFactor;
@@ -73999,8 +74045,8 @@ function Layout(data, options, xlr, layout) {
       $layout.style.zIndex = "".concat(layout.zIndex);
     }
     /* Set the layout background */
-    layout.bgColor = ((_layout$layoutNode4 = layout.layoutNode) === null || _layout$layoutNode4 === void 0 || (_layout$layoutNode4 = _layout$layoutNode4.firstElementChild) === null || _layout$layoutNode4 === void 0 ? void 0 : _layout$layoutNode4.getAttribute('bgcolor')) || '';
-    layout.bgImage = ((_layout$layoutNode5 = layout.layoutNode) === null || _layout$layoutNode5 === void 0 || (_layout$layoutNode5 = _layout$layoutNode5.firstElementChild) === null || _layout$layoutNode5 === void 0 ? void 0 : _layout$layoutNode5.getAttribute('background')) || '';
+    layout.bgColor = ((_layout$layoutNode5 = layout.layoutNode) === null || _layout$layoutNode5 === void 0 || (_layout$layoutNode5 = _layout$layoutNode5.firstElementChild) === null || _layout$layoutNode5 === void 0 ? void 0 : _layout$layoutNode5.getAttribute('bgcolor')) || '';
+    layout.bgImage = ((_layout$layoutNode6 = layout.layoutNode) === null || _layout$layoutNode6 === void 0 || (_layout$layoutNode6 = _layout$layoutNode6.firstElementChild) === null || _layout$layoutNode6 === void 0 ? void 0 : _layout$layoutNode6.getAttribute('background')) || '';
     if (!(layout.bgImage === "" || typeof layout.bgImage === 'undefined')) {
       /* Extract the image ID from the filename */
       layout.bgId = layout.bgImage.substring(0, layout.bgImage.indexOf('.'));
@@ -74023,19 +74069,19 @@ function Layout(data, options, xlr, layout) {
       $layout.style.display = 'none';
     }
     // Create actions
-    var layoutActions = Array.from((layout === null || layout === void 0 || (_layout$layoutNode6 = layout.layoutNode) === null || _layout$layoutNode6 === void 0 ? void 0 : _layout$layoutNode6.getElementsByTagName('action')) || []);
+    var layoutActions = Array.from((layout === null || layout === void 0 || (_layout$layoutNode7 = layout.layoutNode) === null || _layout$layoutNode7 === void 0 ? void 0 : _layout$layoutNode7.getElementsByTagName('action')) || []);
     Array.from(layoutActions).forEach(function (actionXml, indx) {
       layout.actions.push(new Action((actionXml === null || actionXml === void 0 ? void 0 : actionXml.getAttribute('id')) || '', actionXml));
     });
     // Create interactive actions
     layout.actionController = new ActionController(layout, layout.actions, options);
     // Create drawer
-    var layoutDrawers = Array.from((layout === null || layout === void 0 || (_layout$layoutNode7 = layout.layoutNode) === null || _layout$layoutNode7 === void 0 ? void 0 : _layout$layoutNode7.getElementsByTagName('drawer')) || []);
+    var layoutDrawers = Array.from((layout === null || layout === void 0 || (_layout$layoutNode8 = layout.layoutNode) === null || _layout$layoutNode8 === void 0 ? void 0 : _layout$layoutNode8.getElementsByTagName('drawer')) || []);
     Array.from(layoutDrawers).forEach(function (layoutDrawerXml) {
       layout.drawer = layoutDrawerXml;
     });
     // Create regions
-    var layoutRegions = Array.from((layout === null || layout === void 0 || (_layout$layoutNode8 = layout.layoutNode) === null || _layout$layoutNode8 === void 0 ? void 0 : _layout$layoutNode8.getElementsByTagName('region')) || []);
+    var layoutRegions = Array.from((layout === null || layout === void 0 || (_layout$layoutNode9 = layout.layoutNode) === null || _layout$layoutNode9 === void 0 ? void 0 : _layout$layoutNode9.getElementsByTagName('region')) || []);
     Array.from(layoutRegions).forEach(function (regionXml, indx) {
       var regionObj = Region(layout, regionXml, (regionXml === null || regionXml === void 0 ? void 0 : regionXml.getAttribute('id')) || '', options, xlr);
       regionObj.index = indx;
@@ -74553,6 +74599,7 @@ function XiboLayoutRenderer(inputLayouts, options) {
               var xlrLayoutObj = initialLayout;
               xlrLayoutObj.id = Number(inputLayout.layoutId);
               xlrLayoutObj.layoutId = Number(inputLayout.layoutId);
+              xlrLayoutObj.scheduleId = (inputLayout === null || inputLayout === void 0 ? void 0 : inputLayout.scheduleId) || undefined;
               xlrLayoutObj.options = newOptions;
               xlrLayoutObj.index = getIndexByLayoutId(_this3.inputLayouts, xlrLayoutObj.layoutId).index;
               resolve(Layout(layoutXlfNode, newOptions, self, xlrLayoutObj));