@raydiant/playlist-window-manager 0.14.24 → 0.15.0

package/build/PlaylistWindowManager.d.ts

@@ -57,6 +57,7 @@ export default class PlaylistWindowManager extends EventEmitter {
     setRuleEngine(ruleEngine: RE.RuleEngine): Promise<void>;
     getState(): PlaylistWindowManagerState | null;
     setState(state: PlaylistWindowManagerState): void;
+    reinitializeRuleEngineState(newRulesDataStoreObj: RE.RulesDataStore): void;
     reinitialize(state: PlaylistWindowManagerState, ruleEngine: RE.RuleEngine, shouldInterruptPlayback: boolean): Promise<void>;
     private registerInterrupt;
     endCurrentPresentation(): void;
@@ -89,6 +90,7 @@ export default class PlaylistWindowManager extends EventEmitter {
     private handleCurrentPresentationComplete;
     private handleCurrentPresentationError;
     private handleNextPresentationError;
+    private checkPreviewAction;
     private startPreviewCheck;
     private stopInterruptCheck;
     private getTheme;

package/build/PlaylistWindowManager.js

@@ -270,6 +270,35 @@ var PlaylistWindowManager = /** @class */ (function (_super) {
                 }
             });
         }); };
+        _this.checkPreviewAction = function () { return __awaiter(_this, void 0, void 0, function () {
+            var logger, preview;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        logger = this.options.logger;
+                        if (!this.ruleEngine) {
+                            return [2 /*return*/];
+                        }
+                        preview = this.ruleEngine.previewNext();
+                        if (!this.shouldPreload(preview.presentationId)) return [3 /*break*/, 3];
+                        logger.info("Preview check replacing preloaded presentation '" + this.nextPresentationId() + "' with new presentation '" + preview.presentationId + "'");
+                        return [4 /*yield*/, this.removeNextWindow()];
+                    case 1:
+                        _a.sent();
+                        this.nextPresentation = preview;
+                        return [4 /*yield*/, this.preloadNextWindow()];
+                    case 2:
+                        _a.sent();
+                        _a.label = 3;
+                    case 3:
+                        if (preview.shouldInterrupt) {
+                            logger.info("Interrupting current presentation with '" + preview.presentationId + "'");
+                            this.registerInterrupt();
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        }); };
         _this.ruleEngine = options.ruleEngine;
         _this.state = options.state;
         _this.bounds = options.bounds;
@@ -430,6 +459,39 @@ var PlaylistWindowManager = /** @class */ (function (_super) {
     PlaylistWindowManager.prototype.setState = function (state) {
         this.state = state;
     };
+    // For setting dynamic tags data from workers and reevaluate rules for playlists
+    // input: newRulesDataStoreObj: {'workers': {'ai': {'percentMales': 30}}}
+    PlaylistWindowManager.prototype.reinitializeRuleEngineState = function (newRulesDataStoreObj) {
+        var _this = this;
+        var logger = this.options.logger;
+        logger.info('Dynamic Rule engine state change event received!');
+        if (this.ruleEngine) {
+            logger.info("Existing Rule Data Store: ", this.ruleEngine.state);
+            logger.info("New Rule Data Store data received: ", newRulesDataStoreObj);
+            this.ruleEngine.state.rulesDataStore = newRulesDataStoreObj;
+        }
+        else {
+            logger.warn("No Rule engine found for reinitiazling the state!");
+            return;
+        }
+        // re-evaluate the next presentations depending upon the new rule engine state
+        var checkOverridePresentation = function () { return __awaiter(_this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                if (this.ruleEngine) {
+                    this.checkPreviewAction();
+                    // calling reinitialize Rule engine state for inner playlist windows (for MZ)
+                    if (this.currentWindow) {
+                        this.currentWindow.reinitializePresentationWindowRuleEngineState(newRulesDataStoreObj);
+                    }
+                    if (this.nextWindow) {
+                        this.nextWindow.reinitializePresentationWindowRuleEngineState(newRulesDataStoreObj);
+                    }
+                }
+                return [2 /*return*/];
+            });
+        }); };
+        checkOverridePresentation();
+    };
     // Replace state and rule engine, and reinitialize the window manager.
     PlaylistWindowManager.prototype.reinitialize = function (state, ruleEngine, shouldInterruptPlayback) {
         return __awaiter(this, void 0, void 0, function () {
@@ -860,39 +922,19 @@ var PlaylistWindowManager = /** @class */ (function (_super) {
     PlaylistWindowManager.prototype.startPreviewCheck = function () {
         var _this = this;
         var checkPreview = function () { return __awaiter(_this, void 0, void 0, function () {
-            var logger, preview, now, nextMinute, timeUntilNextMinute;
+            var now, nextMinute, timeUntilNextMinute;
             return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        logger = this.options.logger;
-                        if (!this.ruleEngine) return [3 /*break*/, 4];
-                        preview = this.ruleEngine.previewNext();
-                        if (!this.shouldPreload(preview.presentationId)) return [3 /*break*/, 3];
-                        logger.info("Preview check replacing preloaded presentation '" + this.nextPresentationId() + "' with new presentation '" + preview.presentationId + "'");
-                        return [4 /*yield*/, this.removeNextWindow()];
-                    case 1:
-                        _a.sent();
-                        this.nextPresentation = preview;
-                        return [4 /*yield*/, this.preloadNextWindow()];
-                    case 2:
-                        _a.sent();
-                        _a.label = 3;
-                    case 3:
-                        if (preview.shouldInterrupt) {
-                            logger.info("Interrupting current presentation with '" + preview.presentationId + "'");
-                            this.registerInterrupt();
-                        }
-                        _a.label = 4;
-                    case 4:
-                        now = new Date();
-                        nextMinute = new Date();
-                        nextMinute.setMilliseconds(0);
-                        nextMinute.setSeconds(1);
-                        nextMinute.setMinutes(now.getMinutes() + 1);
-                        timeUntilNextMinute = +nextMinute - +now;
-                        this.interruptCheckTimeout = setTimeout(checkPreview, timeUntilNextMinute);
-                        return [2 /*return*/];
+                if (this.ruleEngine) {
+                    this.checkPreviewAction();
                 }
+                now = new Date();
+                nextMinute = new Date();
+                nextMinute.setMilliseconds(0);
+                nextMinute.setSeconds(1);
+                nextMinute.setMinutes(now.getMinutes() + 1);
+                timeUntilNextMinute = +nextMinute - +now;
+                this.interruptCheckTimeout = setTimeout(checkPreview, timeUntilNextMinute);
+                return [2 /*return*/];
             });
         }); };
         checkPreview();

package/build/PresentationWindow.d.ts

@@ -60,6 +60,7 @@ export default class PresentationWindow {
     show(isFocused?: boolean): void;
     hide(): void;
     remove(): Promise<void>;
+    reinitializePresentationWindowRuleEngineState(newRulesDataStoreObj: RE.RulesDataStore): void;
     play(): void;
     pause(): void;
     resume(): void;

package/build/PresentationWindow.js

@@ -63,7 +63,7 @@ var PlaylistWindowManager_1 = __importDefault(require("./PlaylistWindowManager")
 var WindowTimeoutError_1 = __importDefault(require("./WindowTimeoutError"));
 var WindowLoadError_1 = __importDefault(require("./WindowLoadError"));
 // TODO: Automatically inject latest version when building in CI.
-var defaultAppRendererUrl = 'https://apps.raydiant.com/1.4.6/index.html';
+var defaultAppRendererUrl = 'https://apps.raydiant.com/1.4.7/index.html';
 var isValidNumber = function (value) {
     return typeof value === 'number' && !isNaN(value);
 };
@@ -255,6 +255,12 @@ var PresentationWindow = /** @class */ (function () {
             });
         });
     };
+    // Method to modify the rule engine state for the inner playlist windows (called from outer playlist window manager)
+    PresentationWindow.prototype.reinitializePresentationWindowRuleEngineState = function (newRulesDataStoreObj) {
+        Object.values(this.windowManagers).forEach(function (wm) {
+            wm.reinitializeRuleEngineState(newRulesDataStoreObj);
+        });
+    };
     PresentationWindow.prototype.play = function () {
         var _this = this;
         var _a = this.options, applicationVersion = _a.applicationVersion, presentation = _a.presentation;

package/build/embeddedApps.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 function createEmbeddedApp(presentation, applicationVersion) {
     // build matches
-    var parameterRegex = /(:([\w]+))(.?$|[^\w])/gm;
+    var parameterRegex = /(:([\w-]+))(.?$|[^\w-])/gm;
     var matches = [];
     var match = null;
     do {
@@ -14,8 +14,9 @@ function createEmbeddedApp(presentation, applicationVersion) {
     // replace
     var url = applicationVersion.embeddedUrlFormat || '';
     matches.forEach(function (m) {
-        var variable = m[1];
-        var _a = variable.split(':'), variableName = _a[1];
+        var queryParamVariableName = m[1]; // Where the value of your input will be injected. E.g. ":location"
+        var queryParamName = m[2]; // The query param name. E.g. "location"
+        var _a = queryParamVariableName.split(':'), variableName = _a[1];
         // Don't replace variables that are numbers to allow setting
         // port numbers in the embedded app url.
         if (!isNaN(Number(variableName)))
@@ -24,12 +25,16 @@ function createEmbeddedApp(presentation, applicationVersion) {
         // If the presentation property is not found (this shouldn't happen), default to encoding the value.
         // Otherwise, only skip encoding if the presentation property's encode property is false.
         var shouldEncodeValue = !presentationProperty || presentationProperty.encode !== false;
-        var value = presentation.applicationVariables[m[2]];
+        var value = presentation.applicationVariables[queryParamName];
         if (value === undefined)
             value = '';
-        if (shouldEncodeValue)
+        if (Array.isArray(value)) {
+            value = JSON.stringify(value);
+        }
+        if (shouldEncodeValue) {
             value = encodeURIComponent(value);
-        url = url.replace(variable, value);
+        }
+        url = url.replace(queryParamVariableName, value);
     });
     return url;
 }

package/build/embeddedApps.test.js

@@ -43,6 +43,11 @@ test('Replaces variable with underscore', function () {
         embeddedUrlFormat: 'https://example.com/:foo_1'
     }))).toBe('https://example.com/bar');
 });
+test('Replaces variable with hyphen', function () {
+    expect(embeddedApps_1.default(createPresentation({ applicationVariables: { 'foo-1': 'bar' } }), createApplicationVersion({
+        embeddedUrlFormat: 'https://example.com/:foo-1'
+    }))).toBe('https://example.com/bar');
+});
 test('Does not replace variable that is a number', function () {
     expect(embeddedApps_1.default(createPresentation({ applicationVariables: { foo: 'bar' } }), createApplicationVersion({
         embeddedUrlFormat: 'http://localhost:8080?foo=:foo'
@@ -63,3 +68,10 @@ test('Does not encode value if presentation property disables encoding', functio
         presentationProperties: [{ name: 'url', encode: false }]
     }))).toBe("https://raydiant.com");
 });
+test('Encodes a variables containing an array', function () {
+    var fooValue = ['option-a', 'option-b', 'option-c'];
+    var fooValueEncoded = '%5B%22option-a%22%2C%22option-b%22%2C%22option-c%22%5D';
+    expect(embeddedApps_1.default(createPresentation({ applicationVariables: { foo: fooValue } }), createApplicationVersion({
+        embeddedUrlFormat: "http://localhost:8080?foo=:foo"
+    }))).toBe("http://localhost:8080?foo=" + fooValueEncoded);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raydiant/playlist-window-manager",
-  "version": "0.14.24",
+  "version": "0.15.0",
   "description": "Window manager for playlist playback.",
   "main": "build/index.js",
   "scripts": {
@@ -12,8 +12,8 @@
   },
   "dependencies": {
     "fast-deep-equal": "^3.1.3",
-    "@raydiant/playlist-rule-engine": "3.1.15",
-    "raydiant-kit": "4.7.1",
+    "@raydiant/playlist-rule-engine": "3.2.0",
+    "raydiant-kit": "4.7.3",
     "uuid": "^8.3.0",
     "eventemitter3": "^4.0.7"
   },

package/src/PlaylistWindowManager.ts

@@ -265,6 +265,43 @@ export default class PlaylistWindowManager extends EventEmitter {
     this.state = state;
   }
 
+  // For setting dynamic tags data from workers and reevaluate rules for playlists
+  // input: newRulesDataStoreObj: {'workers': {'ai': {'percentMales': 30}}}
+  public reinitializeRuleEngineState(newRulesDataStoreObj: RE.RulesDataStore) {
+    const { logger } = this.options;
+
+    logger.info('Dynamic Rule engine state change event received!');
+    if (this.ruleEngine) {
+      logger.info(`Existing Rule Data Store: `, this.ruleEngine.state);
+      logger.info(`New Rule Data Store data received: `, newRulesDataStoreObj);
+      this.ruleEngine.state.rulesDataStore = newRulesDataStoreObj;
+    } else {
+      logger.warn(`No Rule engine found for reinitiazling the state!`);
+      return;
+    }
+
+    // re-evaluate the next presentations depending upon the new rule engine state
+    const checkOverridePresentation = async () => {
+      if (this.ruleEngine) {
+        this.checkPreviewAction();
+
+        // calling reinitialize Rule engine state for inner playlist windows (for MZ)
+        if (this.currentWindow) {
+          this.currentWindow.reinitializePresentationWindowRuleEngineState(
+            newRulesDataStoreObj
+          );
+        }
+
+        if (this.nextWindow) {
+          this.nextWindow.reinitializePresentationWindowRuleEngineState(
+            newRulesDataStoreObj
+          );
+        }
+      }
+    };
+    checkOverridePresentation();
+  }
+
   // Replace state and rule engine, and reinitialize the window manager.
   public async reinitialize(
     state: PlaylistWindowManagerState,
@@ -854,30 +891,36 @@ export default class PlaylistWindowManager extends EventEmitter {
     }
   };
 
-  private startPreviewCheck() {
-    const checkPreview = async () => {
-      const { logger } = this.options;
+  private checkPreviewAction = async () => {
+    const { logger } = this.options;
+    if (!this.ruleEngine) {
+      return;
+    }
+    const preview = this.ruleEngine.previewNext();
 
-      if (this.ruleEngine) {
-        const preview = this.ruleEngine.previewNext();
+    if (this.shouldPreload(preview.presentationId)) {
+      logger.info(
+        `Preview check replacing preloaded presentation '${this.nextPresentationId()}' with new presentation '${
+          preview.presentationId
+        }'`
+      );
+      await this.removeNextWindow();
+      this.nextPresentation = preview;
+      await this.preloadNextWindow();
+    }
 
-        if (this.shouldPreload(preview.presentationId)) {
-          logger.info(
-            `Preview check replacing preloaded presentation '${this.nextPresentationId()}' with new presentation '${
-              preview.presentationId
-            }'`
-          );
-          await this.removeNextWindow();
-          this.nextPresentation = preview;
-          await this.preloadNextWindow();
-        }
+    if (preview.shouldInterrupt) {
+      logger.info(
+        `Interrupting current presentation with '${preview.presentationId}'`
+      );
+      this.registerInterrupt();
+    }
+  };
 
-        if (preview.shouldInterrupt) {
-          logger.info(
-            `Interrupting current presentation with '${preview.presentationId}'`
-          );
-          this.registerInterrupt();
-        }
+  private startPreviewCheck() {
+    const checkPreview = async () => {
+      if (this.ruleEngine) {
+        this.checkPreviewAction();
       }
 
       // Check the preview again on the next minute.

package/src/PresentationWindow.ts

@@ -49,7 +49,7 @@ export interface PresentationWindowOptions {
 }
 
 // TODO: Automatically inject latest version when building in CI.
-const defaultAppRendererUrl = 'https://apps.raydiant.com/1.4.6/index.html';
+const defaultAppRendererUrl = 'https://apps.raydiant.com/1.4.7/index.html';
 
 const isValidNumber = (value: any) =>
   typeof value === 'number' && !isNaN(value);
@@ -180,6 +180,15 @@ export default class PresentationWindow {
     }
   }
 
+  // Method to modify the rule engine state for the inner playlist windows (called from outer playlist window manager)
+  public reinitializePresentationWindowRuleEngineState(
+    newRulesDataStoreObj: RE.RulesDataStore
+  ) {
+    Object.values(this.windowManagers).forEach(wm => {
+      wm.reinitializeRuleEngineState(newRulesDataStoreObj);
+    });
+  }
+
   public play(): void {
     const { applicationVersion, presentation } = this.options;
 

package/src/embeddedApps.test.ts

@@ -77,6 +77,17 @@ test('Replaces variable with underscore', () => {
   ).toBe('https://example.com/bar');
 });
 
+test('Replaces variable with hyphen', () => {
+  expect(
+    createEmbeddedApp(
+      createPresentation({ applicationVariables: { 'foo-1': 'bar' } }),
+      createApplicationVersion({
+        embeddedUrlFormat: 'https://example.com/:foo-1'
+      })
+    )
+  ).toBe('https://example.com/bar');
+});
+
 test('Does not replace variable that is a number', () => {
   expect(
     createEmbeddedApp(
@@ -116,3 +127,18 @@ test('Does not encode value if presentation property disables encoding', () => {
     )
   ).toBe(`https://raydiant.com`);
 });
+
+test('Encodes a variables containing an array', () => {
+  const fooValue = ['option-a', 'option-b', 'option-c'];
+  const fooValueEncoded =
+    '%5B%22option-a%22%2C%22option-b%22%2C%22option-c%22%5D';
+
+  expect(
+    createEmbeddedApp(
+      createPresentation({ applicationVariables: { foo: fooValue } }),
+      createApplicationVersion({
+        embeddedUrlFormat: `http://localhost:8080?foo=:foo`
+      })
+    )
+  ).toBe(`http://localhost:8080?foo=${fooValueEncoded}`);
+});

package/src/embeddedApps.ts

@@ -5,7 +5,7 @@ export default function createEmbeddedApp(
   applicationVersion: ApplicationVersion
 ) {
   // build matches
-  const parameterRegex = /(:([\w]+))(.?$|[^\w])/gm;
+  const parameterRegex = /(:([\w-]+))(.?$|[^\w-])/gm;
   const matches = [];
   let match = null;
   do {
@@ -19,8 +19,10 @@ export default function createEmbeddedApp(
   // replace
   let url = applicationVersion.embeddedUrlFormat || '';
   matches.forEach(m => {
-    const variable = m[1];
-    const [, variableName] = variable.split(':');
+    const queryParamVariableName = m[1]; // Where the value of your input will be injected. E.g. ":location"
+    const queryParamName = m[2]; // The query param name. E.g. "location"
+
+    const [, variableName] = queryParamVariableName.split(':');
     // Don't replace variables that are numbers to allow setting
     // port numbers in the embedded app url.
     if (!isNaN(Number(variableName))) return;
@@ -34,11 +36,16 @@ export default function createEmbeddedApp(
     const shouldEncodeValue =
       !presentationProperty || presentationProperty.encode !== false;
 
-    let value = presentation.applicationVariables[m[2]];
+    let value = presentation.applicationVariables[queryParamName];
     if (value === undefined) value = '';
-    if (shouldEncodeValue) value = encodeURIComponent(value);
+    if (Array.isArray(value)) {
+      value = JSON.stringify(value);
+    }
+    if (shouldEncodeValue) {
+      value = encodeURIComponent(value);
+    }
 
-    url = url.replace(variable, value);
+    url = url.replace(queryParamVariableName, value);
   });
 
   return url;