@raydiant/playlist-window-manager 0.14.22 → 0.14.25

package/README.md

@@ -1,4 +1,10 @@
-Usage:
+## Deployment
+
+```
+yarn deploy
+```
+
+## Usage
 
 ```js
 

package/build/IFrameRenderer.js

@@ -52,9 +52,14 @@ var IFrameRenderer = /** @class */ (function () {
                 console.warn("Invalid message received from iframe '" + JSON.stringify(event.data) + "', ignoring message");
                 return;
             }
+            if (!windowId) {
+                // ignore messages that don't have windowId
+                // such message are comming from 3rd party IFrames like google
+                return;
+            }
             var window = _this.getWindow(windowId);
             if (!window) {
-                throw new Error("Failed add receive message callback to window, missing window id '" + windowId + "'");
+                throw new Error("Failed add receive message callback to window, window with window id: '" + windowId + "' was not found");
             }
             if (window.receiveMessageCallback) {
                 window.receiveMessageCallback(type, payload);

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.5/index.html';
+var defaultAppRendererUrl = 'https://apps.raydiant.com/1.4.6/index.html';
 var isValidNumber = function (value) {
     return typeof value === 'number' && !isNaN(value);
 };

package/build/embeddedApps.js

@@ -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

@@ -63,3 +63,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.22",
+  "version": "0.14.25",
   "description": "Window manager for playlist playback.",
   "main": "build/index.js",
   "scripts": {
@@ -13,7 +13,7 @@
   "dependencies": {
     "fast-deep-equal": "^3.1.3",
     "@raydiant/playlist-rule-engine": "3.1.15",
-    "raydiant-kit": "^4.6.1",
+    "raydiant-kit": "4.7.1",
     "uuid": "^8.3.0",
     "eventemitter3": "^4.0.7"
   },

package/src/IFrameRenderer.ts

@@ -202,10 +202,16 @@ export default class IFrameRenderer implements PresentationWindowRenderer {
       return;
     }
 
+    if (!windowId) {
+      // ignore messages that don't have windowId
+      // such message are comming from 3rd party IFrames like google
+      return;
+    }
+
     const window = this.getWindow(windowId);
     if (!window) {
       throw new Error(
-        `Failed add receive message callback to window, missing window id '${windowId}'`
+        `Failed add receive message callback to window, window with window id: '${windowId}' was not found`
       );
     }
 

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.5/index.html';
+const defaultAppRendererUrl = 'https://apps.raydiant.com/1.4.6/index.html';
 
 const isValidNumber = (value: any) =>
   typeof value === 'number' && !isNaN(value);

package/src/embeddedApps.test.ts

@@ -116,3 +116,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

@@ -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;