@raydiant/playlist-window-manager 0.26.2 → 0.27.0

package/build/PresentationWindow.js

@@ -1144,10 +1144,13 @@ var PresentationWindow = /** @class */ (function () {
         }
     };
     PresentationWindow.prototype.getEmbeddedAppUrl = function () {
-        var _a = this.options, windowId = _a.windowId, appRendererOfflineSupport = _a.appRendererOfflineSupport;
+        var _a = this.options, windowId = _a.windowId, appRendererOfflineSupport = _a.appRendererOfflineSupport, device = _a.device;
         var metadata = {
             renderMode: this.options.isPreview ? 'preview' : 'live',
         };
+        if (device) {
+            metadata.deviceId = device.id;
+        }
         var url = (0, embeddedApps_1.default)(this.presentation, this.options.applicationVersion, metadata);
         return this.getFullAppRendererUrl({
             appRendererUrl: url,

package/build/embeddedApps.js

@@ -13,6 +13,7 @@ function createEmbeddedApp(presentation, applicationVersion, metadata) {
     } while (match !== null);
     // replace
     var url = applicationVersion.embeddedUrlFormat || '';
+    var queryIndex = url.indexOf('?');
     matches.forEach(function (m) {
         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"
@@ -20,6 +21,8 @@ function createEmbeddedApp(presentation, applicationVersion, metadata) {
         var shouldEncodeValue = true;
         var value = '';
         if (variableName.charAt(0) === '$') {
+            var variableIndex = url.indexOf(queryParamVariableName);
+            var isPartOfQuery = queryIndex != -1 && variableIndex > queryIndex;
             var metadataKey = variableName.slice(1);
             if (metadataKey === 'renderMode') {
                 value = metadata.renderMode;
@@ -27,6 +30,18 @@ function createEmbeddedApp(presentation, applicationVersion, metadata) {
             else if (metadataKey === 'token') {
                 value = presentation.token;
             }
+            else if (metadataKey === 'deviceId') {
+                if (metadata.deviceId) {
+                    value = metadata.deviceId;
+                }
+                else {
+                    // If :$deviceId is part of the URL path, avoid creating a broken URL if metadata.deviceId is not defined.
+                    // This will use the variable name as the value instead of an empty string.
+                    if (!isPartOfQuery) {
+                        value = queryParamVariableName;
+                    }
+                }
+            }
         }
         else {
             // Don't replace variables that are numbers to allow setting

package/build/embeddedApps.test.js

@@ -128,3 +128,24 @@ test('Replaces $token with presentation token', function () {
     });
     expect((0, embeddedApps_1.default)(presentation, applicationVersion, createMetadata())).toBe('https://example.com?token=abc');
 });
+test('Replaces $deviceId with metadata deviceId when provided', function () {
+    var presentation = createPresentation();
+    var applicationVersion = createApplicationVersion({
+        embeddedUrlFormat: 'https://example.com/:$deviceId/content',
+    });
+    expect((0, embeddedApps_1.default)(presentation, applicationVersion, createMetadata({ deviceId: 'device-id' }))).toBe('https://example.com/device-id/content');
+});
+test('Do not replace $deviceId when in the URI with metadata not defined', function () {
+    var presentation = createPresentation();
+    var applicationVersion = createApplicationVersion({
+        embeddedUrlFormat: 'https://example.com/:$deviceId/content',
+    });
+    expect((0, embeddedApps_1.default)(presentation, applicationVersion, createMetadata())).toBe("https://example.com/".concat(encodeURIComponent(':$deviceId'), "/content"));
+});
+test('Replaces $deviceId with empty string when in the query string and metadata not defined', function () {
+    var presentation = createPresentation();
+    var applicationVersion = createApplicationVersion({
+        embeddedUrlFormat: 'https://example.com/content?device=:$deviceId',
+    });
+    expect((0, embeddedApps_1.default)(presentation, applicationVersion, createMetadata())).toBe("https://example.com/content?device=");
+});

package/build/types.d.ts

@@ -135,6 +135,7 @@ export interface InputState {
 }
 export interface EmbeddedAppMetadata {
     renderMode: 'preview' | 'live';
+    deviceId?: string;
 }
 export interface AnalyticsEvent {
     type: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raydiant/playlist-window-manager",
-  "version": "0.26.2",
+  "version": "0.27.0",
   "description": "Window manager for playlist playback.",
   "main": "build/index.js",
   "scripts": {

package/src/PresentationWindow.ts

@@ -953,12 +953,16 @@ export default class PresentationWindow {
   }
 
   private getEmbeddedAppUrl() {
-    const { windowId, appRendererOfflineSupport } = this.options;
+    const { windowId, appRendererOfflineSupport, device } = this.options;
 
     const metadata: EmbeddedAppMetadata = {
       renderMode: this.options.isPreview ? 'preview' : 'live',
     };
 
+    if (device) {
+      metadata.deviceId = device.id;
+    }
+
     const url = createEmbeddedApp(
       this.presentation,
       this.options.applicationVersion,

package/src/embeddedApps.test.ts

@@ -240,3 +240,40 @@ test('Replaces $token with presentation token', () => {
     createEmbeddedApp(presentation, applicationVersion, createMetadata())
   ).toBe('https://example.com?token=abc');
 });
+
+test('Replaces $deviceId with metadata deviceId when provided', () => {
+  const presentation = createPresentation();
+  const applicationVersion = createApplicationVersion({
+    embeddedUrlFormat: 'https://example.com/:$deviceId/content',
+  });
+
+  expect(
+    createEmbeddedApp(
+      presentation,
+      applicationVersion,
+      createMetadata({ deviceId: 'device-id' })
+    )
+  ).toBe('https://example.com/device-id/content');
+});
+
+test('Do not replace $deviceId when in the URI with metadata not defined', () => {
+  const presentation = createPresentation();
+  const applicationVersion = createApplicationVersion({
+    embeddedUrlFormat: 'https://example.com/:$deviceId/content',
+  });
+
+  expect(
+    createEmbeddedApp(presentation, applicationVersion, createMetadata())
+  ).toBe(`https://example.com/${encodeURIComponent(':$deviceId')}/content`);
+});
+
+test('Replaces $deviceId with empty string when in the query string and metadata not defined', () => {
+  const presentation = createPresentation();
+  const applicationVersion = createApplicationVersion({
+    embeddedUrlFormat: 'https://example.com/content?device=:$deviceId',
+  });
+
+  expect(
+    createEmbeddedApp(presentation, applicationVersion, createMetadata())
+  ).toBe(`https://example.com/content?device=`);
+});

package/src/embeddedApps.ts

@@ -19,6 +19,7 @@ export default function createEmbeddedApp(
 
   // replace
   let url = applicationVersion.embeddedUrlFormat || '';
+  const queryIndex = url.indexOf('?');
   matches.forEach((m) => {
     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"
@@ -29,11 +30,24 @@ export default function createEmbeddedApp(
     let value: any = '';
 
     if (variableName.charAt(0) === '$') {
+      const variableIndex = url.indexOf(queryParamVariableName);
+      const isPartOfQuery = queryIndex != -1 && variableIndex > queryIndex;
+
       const metadataKey = variableName.slice(1);
       if (metadataKey === 'renderMode') {
         value = metadata.renderMode;
       } else if (metadataKey === 'token') {
         value = presentation.token;
+      } else if (metadataKey === 'deviceId') {
+        if (metadata.deviceId) {
+          value = metadata.deviceId;
+        } else {
+          // If :$deviceId is part of the URL path, avoid creating a broken URL if metadata.deviceId is not defined.
+          // This will use the variable name as the value instead of an empty string.
+          if (!isPartOfQuery) {
+            value = queryParamVariableName;
+          }
+        }
       }
     } else {
       // Don't replace variables that are numbers to allow setting

package/src/types.ts

@@ -167,6 +167,7 @@ export interface InputState {
 
 export interface EmbeddedAppMetadata {
   renderMode: 'preview' | 'live';
+  deviceId?: string;
 }
 
 export interface AnalyticsEvent {