@raydiant/playlist-window-manager 0.23.0 → 0.23.2

package/build/PlaylistWindowManager.d.ts

@@ -9,6 +9,7 @@ export interface PlaylistWindowManagerOptions {
     device?: Device;
     readyTimeoutDurationSeconds?: number;
     appRendererUrl?: string;
+    appRendererOfflineSupport?: boolean;
     bounds?: WindowBounds;
     backgroundColor?: string;
     themeOverride?: Theme;

package/build/PlaylistWindowManager.js

@@ -677,7 +677,7 @@ var PlaylistWindowManager = /** @class */ (function (_super) {
         }
     };
     PlaylistWindowManager.prototype.createWindow = function (pr) {
-        var _a = this.options, readyTimeoutDurationSeconds = _a.readyTimeoutDurationSeconds, appRendererUrl = _a.appRendererUrl, backgroundColor = _a.backgroundColor, device = _a.device, logger = _a.logger, windowName = _a.windowName, parentWindowId = _a.parentWindowId, isPreview = _a.isPreview;
+        var _a = this.options, readyTimeoutDurationSeconds = _a.readyTimeoutDurationSeconds, appRendererUrl = _a.appRendererUrl, appRendererOfflineSupport = _a.appRendererOfflineSupport, backgroundColor = _a.backgroundColor, device = _a.device, logger = _a.logger, windowName = _a.windowName, parentWindowId = _a.parentWindowId, isPreview = _a.isPreview;
         if (!this.ruleEngine) {
             throw new Error('Attempted to create window but ruleEngine was not provided');
         }
@@ -712,6 +712,7 @@ var PlaylistWindowManager = /** @class */ (function (_super) {
             forceMute: this.forceMute,
             readyTimeoutDurationSeconds: readyTimeoutDurationSeconds,
             appRendererUrl: appRendererUrl,
+            appRendererOfflineSupport: appRendererOfflineSupport,
             bounds: this.bounds,
             backgroundColor: backgroundColor,
             playlistWindowManagerState: this.state,
@@ -894,7 +895,7 @@ var PlaylistWindowManager = /** @class */ (function (_super) {
     };
     PlaylistWindowManager.prototype.swapWindows = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var nextPreviewPresentationId, preview, result, shouldPreload;
+            var nextPreviewPresentationId, preview, result, nextPresentation, shouldPreload;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -910,6 +911,7 @@ var PlaylistWindowManager = /** @class */ (function (_super) {
                             preview = result.preview;
                             nextPreviewPresentationId = preview.presentationId;
                         }
+                        nextPresentation = this.nextPresentation;
                         // Set this.currentPresentationId before removing the current window to avoid timing issues with previewCheck
                         // triggering during removeCurrentWindow. Current presentation id needs to be set to the next
                         // presentation before calling shouldPreload().
@@ -939,6 +941,11 @@ var PlaylistWindowManager = /** @class */ (function (_super) {
                         // Swap windows.
                         this.currentWindow = this.nextWindow;
                         if (this.currentWindow) {
+                            // Restore this.currentPresentation value since if this.removeCurrentWindow()
+                            // was called then this.currentPresentation was set to null.
+                            // This fixes an issue where publishing a playlist with single presentation results
+                            // in two iFrames created. See CX-2602 for more details.
+                            this.currentPresentation = nextPresentation;
                             this.currentWindow.onComplete(this.handleCurrentPresentationComplete);
                             this.currentWindow.onError(this.handleCurrentPresentationError);
                             this.currentWindow.onEnableInterruptLock(this.handleEnableInterruptLock);

package/build/PresentationWindow.d.ts

@@ -23,6 +23,7 @@ export interface PresentationWindowOptions {
     renderer: PresentationWindowRenderer;
     readyTimeoutDurationSeconds?: number;
     appRendererUrl?: string;
+    appRendererOfflineSupport?: boolean;
     bounds?: WindowBounds;
     backgroundColor?: string;
     isPreview?: boolean;
@@ -102,7 +103,7 @@ export default class PresentationWindow {
     private isEmbeddedApp;
     private allChildWindowManagersReady;
     private checkIsReadyCallback;
-    private appendWindowIdToHash;
+    private getFullAppRendererUrl;
     private loadEmbeddedApp;
     private loadLegacyApp;
     private createAndLoadWindow;

package/build/PresentationWindow.js

@@ -81,7 +81,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/3.0.4/index.html';
+var defaultAppRendererUrl = 'https://apps.raydiant.com/3.0.5/index.html';
 var isValidNumber = function (value) {
     return typeof value === 'number' && !isNaN(value);
 };
@@ -690,10 +690,14 @@ var PresentationWindow = /** @class */ (function () {
             }
         }
     };
-    PresentationWindow.prototype.appendWindowIdToHash = function (urlStr, windowId) {
-        var url = new URL(urlStr);
+    PresentationWindow.prototype.getFullAppRendererUrl = function (_a) {
+        var appRendererUrl = _a.appRendererUrl, windowId = _a.windowId, appRendererOfflineSupport = _a.appRendererOfflineSupport;
+        var url = new URL(appRendererUrl);
         var hashParams = new URLSearchParams(url.hash.slice(1));
         hashParams.set('__raydiantWindowId', windowId);
+        if (appRendererOfflineSupport === true) {
+            hashParams.set('__raydiantOfflineSupport', 'true');
+        }
         url.hash = hashParams.toString();
         return url.toString();
     };
@@ -724,13 +728,17 @@ var PresentationWindow = /** @class */ (function () {
     };
     PresentationWindow.prototype.loadLegacyApp = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, windowId, _b, appRendererUrl, backgroundColor;
+            var _a, windowId, _b, appRendererUrl, appRendererOfflineSupport, backgroundColor;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
-                        _a = this.options, windowId = _a.windowId, _b = _a.appRendererUrl, appRendererUrl = _b === void 0 ? defaultAppRendererUrl : _b, backgroundColor = _a.backgroundColor;
+                        _a = this.options, windowId = _a.windowId, _b = _a.appRendererUrl, appRendererUrl = _b === void 0 ? defaultAppRendererUrl : _b, appRendererOfflineSupport = _a.appRendererOfflineSupport, backgroundColor = _a.backgroundColor;
                         this.logInfo("Create window '".concat(windowId, "'"));
-                        return [4 /*yield*/, this.createAndLoadWindow(this.appendWindowIdToHash(appRendererUrl, windowId), backgroundColor || '#000000', // Default to black bg for Raydiant apps
+                        return [4 /*yield*/, this.createAndLoadWindow(this.getFullAppRendererUrl({
+                                appRendererUrl: appRendererUrl,
+                                windowId: windowId,
+                                appRendererOfflineSupport: appRendererOfflineSupport,
+                            }), backgroundColor || '#000000', // Default to black bg for Raydiant apps
                             this.handleLegacyMessage)];
                     case 1:
                         _c.sent();
@@ -1034,12 +1042,16 @@ var PresentationWindow = /** @class */ (function () {
         }
     };
     PresentationWindow.prototype.getEmbeddedAppUrl = function () {
-        var windowId = this.options.windowId;
+        var _a = this.options, windowId = _a.windowId, appRendererOfflineSupport = _a.appRendererOfflineSupport;
         var metadata = {
             renderMode: this.options.isPreview ? 'preview' : 'live',
         };
         var url = (0, embeddedApps_1.default)(this.presentation, this.options.applicationVersion, metadata);
-        return this.appendWindowIdToHash(url, windowId);
+        return this.getFullAppRendererUrl({
+            appRendererUrl: url,
+            windowId: windowId,
+            appRendererOfflineSupport: appRendererOfflineSupport,
+        });
     };
     PresentationWindow.prototype.handleReady = function () {
         this.didReceiveReady = true;

package/package.json

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

package/src/PlaylistWindowManager.ts

@@ -40,6 +40,10 @@ export interface PlaylistWindowManagerOptions {
   // Override the default app renderer url
   appRendererUrl?: string;
 
+  // App renderer offline support.
+  // If true, the app renderer will be using service worker to cache resources for offline support.
+  appRendererOfflineSupport?: boolean;
+
   // The bounds of the window manager, used for child windows
   bounds?: WindowBounds;
 
@@ -488,6 +492,7 @@ export default class PlaylistWindowManager extends EventEmitter {
     const {
       readyTimeoutDurationSeconds,
       appRendererUrl,
+      appRendererOfflineSupport,
       backgroundColor,
       device,
       logger,
@@ -541,6 +546,7 @@ export default class PlaylistWindowManager extends EventEmitter {
       forceMute: this.forceMute,
       readyTimeoutDurationSeconds,
       appRendererUrl,
+      appRendererOfflineSupport,
       bounds: this.bounds,
       backgroundColor,
       playlistWindowManagerState: this.state,
@@ -698,6 +704,9 @@ export default class PlaylistWindowManager extends EventEmitter {
       nextPreviewPresentationId = preview.presentationId;
     }
 
+    // Save reference to next presentation since later call to
+    // this.removeCurrentWindow() will set this.currentPresentation to null.
+    const nextPresentation = this.nextPresentation;
     // Set this.currentPresentationId before removing the current window to avoid timing issues with previewCheck
     // triggering during removeCurrentWindow. Current presentation id needs to be set to the next
     // presentation before calling shouldPreload().
@@ -734,6 +743,11 @@ export default class PlaylistWindowManager extends EventEmitter {
     // Swap windows.
     this.currentWindow = this.nextWindow;
     if (this.currentWindow) {
+      // Restore this.currentPresentation value since if this.removeCurrentWindow()
+      // was called then this.currentPresentation was set to null.
+      // This fixes an issue where publishing a playlist with single presentation results
+      // in two iFrames created. See CX-2602 for more details.
+      this.currentPresentation = nextPresentation;
       this.currentWindow.onComplete(this.handleCurrentPresentationComplete);
       this.currentWindow.onError(this.handleCurrentPresentationError);
       this.currentWindow.onEnableInterruptLock(this.handleEnableInterruptLock);

package/src/PresentationWindow.ts

@@ -47,6 +47,7 @@ export interface PresentationWindowOptions {
   renderer: PresentationWindowRenderer;
   readyTimeoutDurationSeconds?: number;
   appRendererUrl?: string;
+  appRendererOfflineSupport?: boolean;
   bounds?: WindowBounds;
   backgroundColor?: string;
   isPreview?: boolean;
@@ -60,7 +61,7 @@ export interface PresentationWindowOptions {
 }
 
 // TODO: Automatically inject latest version when building in CI.
-const defaultAppRendererUrl = 'https://apps.raydiant.com/3.0.4/index.html';
+const defaultAppRendererUrl = 'https://apps.raydiant.com/3.0.5/index.html';
 
 const isValidNumber = (value: any) =>
   typeof value === 'number' && !isNaN(value);
@@ -488,10 +489,21 @@ export default class PresentationWindow {
     }
   }
 
-  private appendWindowIdToHash(urlStr: string, windowId: string) {
-    const url = new URL(urlStr);
+  private getFullAppRendererUrl({
+    appRendererUrl,
+    windowId,
+    appRendererOfflineSupport,
+  }: {
+    appRendererUrl: string;
+    windowId: string;
+    appRendererOfflineSupport: boolean | undefined;
+  }) {
+    const url = new URL(appRendererUrl);
     const hashParams = new URLSearchParams(url.hash.slice(1));
     hashParams.set('__raydiantWindowId', windowId);
+    if (appRendererOfflineSupport === true) {
+      hashParams.set('__raydiantOfflineSupport', 'true');
+    }
     url.hash = hashParams.toString();
 
     return url.toString();
@@ -525,13 +537,18 @@ export default class PresentationWindow {
     const {
       windowId,
       appRendererUrl = defaultAppRendererUrl,
+      appRendererOfflineSupport,
       backgroundColor,
     } = this.options;
 
     this.logInfo(`Create window '${windowId}'`);
 
     await this.createAndLoadWindow(
-      this.appendWindowIdToHash(appRendererUrl, windowId),
+      this.getFullAppRendererUrl({
+        appRendererUrl,
+        windowId,
+        appRendererOfflineSupport,
+      }),
       backgroundColor || '#000000', // Default to black bg for Raydiant apps
       this.handleLegacyMessage
     );
@@ -861,7 +878,7 @@ export default class PresentationWindow {
   }
 
   private getEmbeddedAppUrl() {
-    const { windowId } = this.options;
+    const { windowId, appRendererOfflineSupport } = this.options;
 
     const metadata: EmbeddedAppMetadata = {
       renderMode: this.options.isPreview ? 'preview' : 'live',
@@ -873,7 +890,11 @@ export default class PresentationWindow {
       metadata
     );
 
-    return this.appendWindowIdToHash(url, windowId);
+    return this.getFullAppRendererUrl({
+      appRendererUrl: url,
+      windowId,
+      appRendererOfflineSupport,
+    });
   }
 
   private handleEmbeddedMessage = async (type: string, payload?: any) => {