@raydiant/playlist-window-manager 0.14.19 → 0.14.22

package/build/PresentationWindow.js

@@ -351,7 +351,7 @@ var PresentationWindow = /** @class */ (function () {
                         _a = this.options, applicationVersion = _a.applicationVersion, windowId = _a.windowId;
                         if (!this.isEmbeddedApp()) return [3 /*break*/, 3];
                         if (!applicationVersion.embeddedUrlFormat) return [3 /*break*/, 2];
-                        url = embeddedApps_1.default(this.presentation, applicationVersion.embeddedUrlFormat);
+                        url = embeddedApps_1.default(this.presentation, applicationVersion);
                         this.logInfo("Reload window '" + windowId + "' for embedded app url '" + url + "'");
                         return [4 /*yield*/, this.loadWindow(url)];
                     case 1:
@@ -412,7 +412,7 @@ var PresentationWindow = /** @class */ (function () {
                         if (!applicationVersion.embeddedUrlFormat) {
                             throw new Error("Error loading embedded app, missing embeddedUrlFormat for '" + applicationVersion.id + "'");
                         }
-                        url = embeddedApps_1.default(this.presentation, applicationVersion.embeddedUrlFormat);
+                        url = embeddedApps_1.default(this.presentation, applicationVersion);
                         this.logInfo("Create window '" + windowId + "' for embedded app url '" + url + "'");
                         // Embedded apps should not have a backgroundColor bexcause some sites expect
                         // the browser default of white will be applied. We also don't attach the message

package/build/embeddedApps.d.ts

@@ -1,2 +1,2 @@
-import { Presentation } from './types';
-export default function createEmbeddedApp(presentation: Presentation, embeddedUrlFormat: string): string;
+import { Presentation, ApplicationVersion } from './types';
+export default function createEmbeddedApp(presentation: Presentation, applicationVersion: ApplicationVersion): string;

package/build/embeddedApps.js

@@ -1,18 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-function createEmbeddedApp(presentation, embeddedUrlFormat) {
+function createEmbeddedApp(presentation, applicationVersion) {
     // build matches
     var parameterRegex = /(:([\w]+))(.?$|[^\w])/gm;
     var matches = [];
     var match = null;
     do {
-        match = parameterRegex.exec(embeddedUrlFormat);
+        match = parameterRegex.exec(applicationVersion.embeddedUrlFormat || '');
         if (match) {
             matches.push(match);
         }
     } while (match !== null);
     // replace
-    var url = embeddedUrlFormat;
+    var url = applicationVersion.embeddedUrlFormat || '';
     matches.forEach(function (m) {
         var variable = m[1];
         var _a = variable.split(':'), variableName = _a[1];
@@ -20,9 +20,15 @@ function createEmbeddedApp(presentation, embeddedUrlFormat) {
         // port numbers in the embedded app url.
         if (!isNaN(Number(variableName)))
             return;
+        var presentationProperty = applicationVersion.presentationProperties.find(function (p) { return p.name === variableName; });
+        // 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]];
         if (value === undefined)
             value = '';
+        if (shouldEncodeValue)
+            value = encodeURIComponent(value);
         url = url.replace(variable, value);
     });
     return url;

package/build/embeddedApps.test.js

@@ -22,18 +22,44 @@ var createPresentation = function (overrides) { return (__assign({ id: 'id', nam
         },
         presentationsPlaylists: []
     } }, overrides)); };
+var createApplicationVersion = function (overrides) { return (__assign({ id: 'id', name: 'name', applicationId: 'applicationId', embeddedUrlFormat: null, configurableDuration: false, sourceUrl: null, presentationProperties: [] }, overrides)); };
 test('Replaces variable in query parameteers', function () {
-    expect(embeddedApps_1.default(createPresentation({ applicationVariables: { foo: 'bar' } }), 'https://example.com?foo=:foo')).toBe('https://example.com?foo=bar');
+    expect(embeddedApps_1.default(createPresentation({ applicationVariables: { foo: 'bar' } }), createApplicationVersion({
+        embeddedUrlFormat: 'https://example.com?foo=:foo'
+    }))).toBe('https://example.com?foo=bar');
 });
 test('Replaces variable in path', function () {
-    expect(embeddedApps_1.default(createPresentation({ applicationVariables: { foo: 'bar' } }), 'https://example.com/:foo')).toBe('https://example.com/bar');
+    expect(embeddedApps_1.default(createPresentation({ applicationVariables: { foo: 'bar' } }), createApplicationVersion({
+        embeddedUrlFormat: 'https://example.com/:foo'
+    }))).toBe('https://example.com/bar');
 });
 test('Replaces undefined variable with empty string', function () {
-    expect(embeddedApps_1.default(createPresentation({ applicationVariables: {} }), 'https://example.com/:foo')).toBe('https://example.com/');
+    expect(embeddedApps_1.default(createPresentation({ applicationVariables: {} }), createApplicationVersion({
+        embeddedUrlFormat: 'https://example.com/:foo'
+    }))).toBe('https://example.com/');
 });
 test('Replaces variable with underscore', function () {
-    expect(embeddedApps_1.default(createPresentation({ applicationVariables: { foo_1: 'bar' } }), 'https://example.com/:foo_1')).toBe('https://example.com/bar');
+    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' } }), 'http://localhost:8080?foo=:foo')).toBe('http://localhost:8080?foo=bar');
+    expect(embeddedApps_1.default(createPresentation({ applicationVariables: { foo: 'bar' } }), createApplicationVersion({
+        embeddedUrlFormat: 'http://localhost:8080?foo=:foo'
+    }))).toBe('http://localhost:8080?foo=bar');
+});
+test('Encodes a variables containing special characters', function () {
+    var fooValue = 'Lorem Ipsum. !@#$%^&*()-. More Text';
+    var fooValueEncoded = 'Lorem%20Ipsum.%20!%40%23%24%25%5E%26*()-.%20More%20Text';
+    expect(embeddedApps_1.default(createPresentation({ applicationVariables: { foo: fooValue } }), createApplicationVersion({
+        embeddedUrlFormat: "http://localhost:8080?foo=:foo"
+    }))).toBe("http://localhost:8080?foo=" + fooValueEncoded);
+});
+test('Does not encode value if presentation property disables encoding', function () {
+    expect(embeddedApps_1.default(createPresentation({
+        applicationVariables: { url: 'https://raydiant.com' }
+    }), createApplicationVersion({
+        embeddedUrlFormat: ":url",
+        presentationProperties: [{ name: 'url', encode: false }]
+    }))).toBe("https://raydiant.com");
 });

package/build/types.d.ts

@@ -27,6 +27,10 @@ export interface ApplicationVersion {
     embeddedUrlFormat: string | null;
     configurableDuration: boolean;
     sourceUrl: string | null;
+    presentationProperties: Array<{
+        name: string;
+        encode?: boolean;
+    }>;
 }
 export interface Font {
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raydiant/playlist-window-manager",
-  "version": "0.14.19",
+  "version": "0.14.22",
   "description": "Window manager for playlist playback.",
   "main": "build/index.js",
   "scripts": {
@@ -12,7 +12,7 @@
   },
   "dependencies": {
     "fast-deep-equal": "^3.1.3",
-    "@raydiant/playlist-rule-engine": "3.1.14",
+    "@raydiant/playlist-rule-engine": "3.1.15",
     "raydiant-kit": "^4.6.1",
     "uuid": "^8.3.0",
     "eventemitter3": "^4.0.7"

package/src/PresentationWindow.ts

@@ -299,10 +299,7 @@ export default class PresentationWindow {
 
     if (this.isEmbeddedApp()) {
       if (applicationVersion.embeddedUrlFormat) {
-        const url = createEmbeddedApp(
-          this.presentation,
-          applicationVersion.embeddedUrlFormat
-        );
+        const url = createEmbeddedApp(this.presentation, applicationVersion);
 
         this.logInfo(
           `Reload window '${windowId}' for embedded app url '${url}'`
@@ -368,10 +365,7 @@ export default class PresentationWindow {
       );
     }
 
-    const url = createEmbeddedApp(
-      this.presentation,
-      applicationVersion.embeddedUrlFormat
-    );
+    const url = createEmbeddedApp(this.presentation, applicationVersion);
 
     this.logInfo(`Create window '${windowId}' for embedded app url '${url}'`);
 

package/src/embeddedApps.test.ts

@@ -1,5 +1,5 @@
 import createEmbeddedApp from './embeddedApps';
-import { Presentation } from './types';
+import { Presentation, ApplicationVersion } from './types';
 
 const createPresentation = (
   overrides: Partial<Presentation>
@@ -20,11 +20,26 @@ const createPresentation = (
   ...overrides
 });
 
+const createApplicationVersion = (
+  overrides: Partial<ApplicationVersion>
+): ApplicationVersion => ({
+  id: 'id',
+  name: 'name',
+  applicationId: 'applicationId',
+  embeddedUrlFormat: null,
+  configurableDuration: false,
+  sourceUrl: null,
+  presentationProperties: [],
+  ...overrides
+});
+
 test('Replaces variable in query parameteers', () => {
   expect(
     createEmbeddedApp(
       createPresentation({ applicationVariables: { foo: 'bar' } }),
-      'https://example.com?foo=:foo'
+      createApplicationVersion({
+        embeddedUrlFormat: 'https://example.com?foo=:foo'
+      })
     )
   ).toBe('https://example.com?foo=bar');
 });
@@ -33,7 +48,9 @@ test('Replaces variable in path', () => {
   expect(
     createEmbeddedApp(
       createPresentation({ applicationVariables: { foo: 'bar' } }),
-      'https://example.com/:foo'
+      createApplicationVersion({
+        embeddedUrlFormat: 'https://example.com/:foo'
+      })
     )
   ).toBe('https://example.com/bar');
 });
@@ -42,7 +59,9 @@ test('Replaces undefined variable with empty string', () => {
   expect(
     createEmbeddedApp(
       createPresentation({ applicationVariables: {} }),
-      'https://example.com/:foo'
+      createApplicationVersion({
+        embeddedUrlFormat: 'https://example.com/:foo'
+      })
     )
   ).toBe('https://example.com/');
 });
@@ -51,7 +70,9 @@ test('Replaces variable with underscore', () => {
   expect(
     createEmbeddedApp(
       createPresentation({ applicationVariables: { foo_1: 'bar' } }),
-      'https://example.com/:foo_1'
+      createApplicationVersion({
+        embeddedUrlFormat: 'https://example.com/:foo_1'
+      })
     )
   ).toBe('https://example.com/bar');
 });
@@ -60,7 +81,38 @@ test('Does not replace variable that is a number', () => {
   expect(
     createEmbeddedApp(
       createPresentation({ applicationVariables: { foo: 'bar' } }),
-      'http://localhost:8080?foo=:foo'
+      createApplicationVersion({
+        embeddedUrlFormat: 'http://localhost:8080?foo=:foo'
+      })
     )
   ).toBe('http://localhost:8080?foo=bar');
 });
+
+test('Encodes a variables containing special characters', () => {
+  const fooValue = 'Lorem Ipsum. !@#$%^&*()-. More Text';
+  const fooValueEncoded =
+    'Lorem%20Ipsum.%20!%40%23%24%25%5E%26*()-.%20More%20Text';
+
+  expect(
+    createEmbeddedApp(
+      createPresentation({ applicationVariables: { foo: fooValue } }),
+      createApplicationVersion({
+        embeddedUrlFormat: `http://localhost:8080?foo=:foo`
+      })
+    )
+  ).toBe(`http://localhost:8080?foo=${fooValueEncoded}`);
+});
+
+test('Does not encode value if presentation property disables encoding', () => {
+  expect(
+    createEmbeddedApp(
+      createPresentation({
+        applicationVariables: { url: 'https://raydiant.com' }
+      }),
+      createApplicationVersion({
+        embeddedUrlFormat: `:url`,
+        presentationProperties: [{ name: 'url', encode: false }]
+      })
+    )
+  ).toBe(`https://raydiant.com`);
+});

package/src/embeddedApps.ts

@@ -1,15 +1,15 @@
-import { Presentation } from './types';
+import { Presentation, ApplicationVersion } from './types';
 
 export default function createEmbeddedApp(
   presentation: Presentation,
-  embeddedUrlFormat: string
+  applicationVersion: ApplicationVersion
 ) {
   // build matches
   const parameterRegex = /(:([\w]+))(.?$|[^\w])/gm;
   const matches = [];
   let match = null;
   do {
-    match = parameterRegex.exec(embeddedUrlFormat);
+    match = parameterRegex.exec(applicationVersion.embeddedUrlFormat || '');
 
     if (match) {
       matches.push(match);
@@ -17,7 +17,7 @@ export default function createEmbeddedApp(
   } while (match !== null);
 
   // replace
-  let url = embeddedUrlFormat;
+  let url = applicationVersion.embeddedUrlFormat || '';
   matches.forEach(m => {
     const variable = m[1];
     const [, variableName] = variable.split(':');
@@ -25,8 +25,19 @@ export default function createEmbeddedApp(
     // port numbers in the embedded app url.
     if (!isNaN(Number(variableName))) return;
 
+    const presentationProperty = applicationVersion.presentationProperties.find(
+      p => p.name === variableName
+    );
+
+    // 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.
+    const shouldEncodeValue =
+      !presentationProperty || presentationProperty.encode !== false;
+
     let value = presentation.applicationVariables[m[2]];
     if (value === undefined) value = '';
+    if (shouldEncodeValue) value = encodeURIComponent(value);
+
     url = url.replace(variable, value);
   });
 

package/src/types.ts

@@ -25,6 +25,7 @@ export interface ApplicationVersion {
   embeddedUrlFormat: string | null;
   configurableDuration: boolean;
   sourceUrl: string | null;
+  presentationProperties: Array<{ name: string; encode?: boolean }>;
 }
 
 export interface Font {