@raydiant/playlist-window-manager 0.20.0 → 0.21.0

package/build/testUtils.js

@@ -0,0 +1,208 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRenderer = exports.createLogger = exports.createRuleEngineState = exports.createPlaylistWindowManagerState = exports.createApplicationVersion = exports.createPresentationRelationships = exports.createPresentation = exports.createPresentationWindow = void 0;
+var re = __importStar(require("@raydiant/playlist-rule-engine"));
+var PresentationWindow_1 = __importDefault(require("./PresentationWindow"));
+var PlaylistWindowManagerState_1 = __importDefault(require("./PlaylistWindowManagerState"));
+function createPresentationWindow(overrides) {
+    var _a, _b, _c, _d, _e, _f;
+    if (overrides === void 0) { overrides = {}; }
+    return new PresentationWindow_1.default({
+        windowId: (_a = overrides.windowId) !== null && _a !== void 0 ? _a : 'test',
+        presentation: createPresentation(overrides.presentation),
+        applicationVersion: createApplicationVersion(overrides.applicationVersion),
+        publishedAt: (_b = overrides.publishedAt) !== null && _b !== void 0 ? _b : 'publishedAt',
+        playlistWindowManagerState: (_c = overrides.playlistWindowManagerState) !== null && _c !== void 0 ? _c : createPlaylistWindowManagerState(),
+        ruleEngineState: (_d = overrides.ruleEngineState) !== null && _d !== void 0 ? _d : createRuleEngineState(),
+        logger: createLogger(),
+        workerState: (_e = overrides.workerState) !== null && _e !== void 0 ? _e : {},
+        renderer: (_f = overrides.renderer) !== null && _f !== void 0 ? _f : {
+            createWindow: function () { },
+            loadWindow: function () {
+                return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) {
+                    return [2 /*return*/];
+                }); });
+            },
+            updateWindowBounds: function () { },
+            showWindow: function () { },
+            hideWindow: function () { },
+            removeWindow: function () {
+                return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) {
+                    return [2 /*return*/];
+                }); });
+            },
+            sendMessageString: function () { },
+            sendMessageObject: function () { },
+            muteWindow: function () { },
+            unMuteWindow: function () { },
+        },
+    });
+}
+exports.createPresentationWindow = createPresentationWindow;
+function createPresentation(overrides) {
+    var _a, _b, _c, _d, _e, _f;
+    if (overrides === void 0) { overrides = {}; }
+    return {
+        id: (_a = overrides.id) !== null && _a !== void 0 ? _a : 'id',
+        name: (_b = overrides.name) !== null && _b !== void 0 ? _b : 'name',
+        applicationDeploymentId: (_c = overrides.applicationDeploymentId) !== null && _c !== void 0 ? _c : 'applicationDeploymentId',
+        themeId: (_d = overrides.themeId) !== null && _d !== void 0 ? _d : null,
+        applicationVariables: (_e = overrides.applicationVariables) !== null && _e !== void 0 ? _e : {},
+        duration: (_f = overrides.duration) !== null && _f !== void 0 ? _f : 1,
+        r: createPresentationRelationships(overrides.r),
+    };
+}
+exports.createPresentation = createPresentation;
+function createPresentationRelationships(overrides) {
+    var _a, _b;
+    if (overrides === void 0) { overrides = {}; }
+    return {
+        resource: (_a = overrides.resource) !== null && _a !== void 0 ? _a : {
+            updatedAt: 'updatedAt',
+            createdAt: 'createdAt',
+        },
+        presentationsPlaylists: (_b = overrides.presentationsPlaylists) !== null && _b !== void 0 ? _b : [],
+    };
+}
+exports.createPresentationRelationships = createPresentationRelationships;
+function createApplicationVersion(overrides) {
+    var _a, _b, _c, _d, _e, _f, _g;
+    if (overrides === void 0) { overrides = {}; }
+    return {
+        id: (_a = overrides.id) !== null && _a !== void 0 ? _a : 'id',
+        name: (_b = overrides.name) !== null && _b !== void 0 ? _b : 'name',
+        applicationId: (_c = overrides.applicationId) !== null && _c !== void 0 ? _c : 'applicationId',
+        embeddedUrlFormat: (_d = overrides.embeddedUrlFormat) !== null && _d !== void 0 ? _d : null,
+        configurableDuration: (_e = overrides.configurableDuration) !== null && _e !== void 0 ? _e : false,
+        sourceUrl: (_f = overrides.sourceUrl) !== null && _f !== void 0 ? _f : null,
+        presentationProperties: (_g = overrides.presentationProperties) !== null && _g !== void 0 ? _g : [],
+    };
+}
+exports.createApplicationVersion = createApplicationVersion;
+function createPlaylistWindowManagerState(overrides) {
+    var _a, _b, _c, _d;
+    if (overrides === void 0) { overrides = {}; }
+    return new PlaylistWindowManagerState_1.default({
+        presentations: (_a = overrides.presentations) !== null && _a !== void 0 ? _a : {},
+        applicationVersions: (_b = overrides.applicationVersions) !== null && _b !== void 0 ? _b : {},
+        themes: (_c = overrides.themes) !== null && _c !== void 0 ? _c : {},
+        publishedAt: (_d = overrides.publishedAt) !== null && _d !== void 0 ? _d : 'publishedAt',
+    });
+}
+exports.createPlaylistWindowManagerState = createPlaylistWindowManagerState;
+function createRuleEngineState(playlists, presentations, rulesDataStore, isMultitimezoneEnabled) {
+    if (playlists === void 0) { playlists = {}; }
+    if (presentations === void 0) { presentations = {}; }
+    if (rulesDataStore === void 0) { rulesDataStore = {}; }
+    if (isMultitimezoneEnabled === void 0) { isMultitimezoneEnabled = false; }
+    return new re.State(playlists, presentations, rulesDataStore, isMultitimezoneEnabled);
+}
+exports.createRuleEngineState = createRuleEngineState;
+function createLogger(overrides) {
+    var _a, _b, _c, _d;
+    if (overrides === void 0) { overrides = {}; }
+    var noop = function () { };
+    return {
+        debug: (_a = overrides.debug) !== null && _a !== void 0 ? _a : noop,
+        info: (_b = overrides.info) !== null && _b !== void 0 ? _b : noop,
+        warn: (_c = overrides.warn) !== null && _c !== void 0 ? _c : noop,
+        error: (_d = overrides.error) !== null && _d !== void 0 ? _d : noop,
+    };
+}
+exports.createLogger = createLogger;
+function createRenderer() {
+    var createWindowOpts = null;
+    return {
+        createWindow: jest.fn(function (opts) {
+            createWindowOpts = opts;
+        }),
+        loadWindow: jest.fn(),
+        updateWindowBounds: jest.fn(),
+        showWindow: jest.fn(),
+        hideWindow: jest.fn(),
+        removeWindow: jest.fn(),
+        sendMessageString: jest.fn(),
+        sendMessageObject: jest.fn(),
+        muteWindow: jest.fn(),
+        unMuteWindow: jest.fn(),
+        runReceiveMessageCallback: function (type, payload) {
+            if (createWindowOpts === null || createWindowOpts === void 0 ? void 0 : createWindowOpts.receiveMessageCallback) {
+                createWindowOpts.receiveMessageCallback(type, payload);
+            }
+            else {
+                throw new Error('No receiveMessageCallback defined, make sure to call window.load first');
+            }
+        },
+        runErrorCallback: function (error) {
+            if (createWindowOpts === null || createWindowOpts === void 0 ? void 0 : createWindowOpts.errorCallback) {
+                createWindowOpts.errorCallback(error);
+            }
+            else {
+                throw new Error('No errorCallback defined, make sure to call window.load first');
+            }
+        },
+    };
+}
+exports.createRenderer = createRenderer;

package/build/types.d.ts

@@ -29,6 +29,7 @@ export interface ApplicationVersion {
     sourceUrl: string | null;
     presentationProperties: Array<{
         name: string;
+        type: string;
         encode?: boolean;
     }>;
 }
@@ -74,6 +75,9 @@ export interface WindowBounds {
 export interface WorkerState {
     [key: string]: any;
 }
+export interface PreviewState {
+    inputs: Record<string, any>;
+}
 export interface CreateWindowOptions {
     windowId: string;
     parentWindowId?: string;
@@ -103,7 +107,8 @@ export interface PresentationWindowRenderer {
     showWindow(windowId: string, isFocused: boolean): void;
     hideWindow(windowId: string): void;
     removeWindow(windowId: string): Promise<void>;
-    sendMessage(windowId: string, message: string): void;
+    sendMessageString(windowId: string, message: string): void;
+    sendMessageObject(windowId: string, type: string, payload?: any): void;
     muteWindow(windowId: string): void;
     unMuteWindow(windowId: string): void;
 }
@@ -118,7 +123,7 @@ export interface OpenChildWindowOptions {
     isMuted: boolean;
     theme?: Theme;
 }
-export declare type Path = Array<string | number>;
+export type Path = Array<string | number>;
 export interface BuilderState {
     inputs: InputState[];
     profileId?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raydiant/playlist-window-manager",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "description": "Window manager for playlist playback.",
   "main": "build/index.js",
   "scripts": {
@@ -25,6 +25,6 @@
     "electron": "10.1.5",
     "jest": "^24.8.0",
     "ts-jest": "^24.0.2",
-    "typescript": "^3.5.3"
+    "typescript": "^4.1.2"
   }
 }

package/src/BrowserViewRenderer.ts

@@ -3,7 +3,7 @@ import { BrowserWindow, BrowserView, ipcMain, IpcMainEvent } from 'electron';
 import {
   PresentationWindowRenderer,
   CreateWindowOptions,
-  WindowBounds
+  WindowBounds,
 } from './types';
 
 interface BrowserViewRendererWindow {
@@ -31,13 +31,13 @@ export default class BrowserViewRenderer implements PresentationWindowRenderer {
     parentWindowId,
     bounds,
     backgroundColor,
-    receiveMessageCallback
+    receiveMessageCallback,
   }: CreateWindowOptions) {
     const window = {
       view: new BrowserView({
         webPreferences: {
-          preload: path.join(__dirname, 'preload.js')
-        }
+          preload: path.join(__dirname, 'preload.js'),
+        },
       }),
 
       bounds: bounds || { ...this.mainWindow.getBounds(), x: 0, y: 0 },
@@ -50,7 +50,7 @@ export default class BrowserViewRenderer implements PresentationWindowRenderer {
         if (receiveMessageCallback) {
           receiveMessageCallback(type, payload);
         }
-      }
+      },
     };
 
     this.windows[windowId] = window;
@@ -69,7 +69,7 @@ export default class BrowserViewRenderer implements PresentationWindowRenderer {
     if (!parentWindowId) {
       window.view.setAutoResize({
         width: true,
-        height: true
+        height: true,
       });
     }
   }
@@ -131,7 +131,7 @@ export default class BrowserViewRenderer implements PresentationWindowRenderer {
     delete this.windows[windowId];
   }
 
-  public sendMessage(windowId: string, message: string) {
+  public sendMessageString(windowId: string, message: string) {
     const window = this.getWindow(windowId);
     if (!window) {
       throw new Error(
@@ -142,6 +142,17 @@ export default class BrowserViewRenderer implements PresentationWindowRenderer {
     window.view.webContents.send('electron-main', message);
   }
 
+  public sendMessageObject(windowId: string, type: string, payload?: any) {
+    const window = this.getWindow(windowId);
+    if (!window) {
+      throw new Error(
+        `Failed to send message to window, missing window id '${windowId}'`
+      );
+    }
+
+    window.view.webContents.send('electron-main', { type, payload });
+  }
+
   public muteWindow(windowId: string) {
     const window = this.getWindow(windowId);
     if (!window) {

package/src/BrowserWindowRenderer.ts

@@ -7,13 +7,13 @@ import {
   Event,
   Details,
   BrowserWindowConstructorOptions,
-  BrowserViewConstructorOptions
+  BrowserViewConstructorOptions,
 } from 'electron';
 import {
   PresentationWindowRenderer,
   CreateWindowOptions,
   WindowBounds,
-  Logger
+  Logger,
 } from './types';
 import WindowUnresponsiveError from './WindowUnresponsiveError';
 
@@ -47,7 +47,8 @@ interface BrowserWindowRendererOptions {
 }
 
 export default class BrowserWindowRenderer
-  implements PresentationWindowRenderer {
+  implements PresentationWindowRenderer
+{
   private windows: {
     [windowId: string]: BrowserWindowRendererWindow;
   } = {};
@@ -62,8 +63,8 @@ export default class BrowserWindowRenderer
     frame: this.opts.frame,
     hasShadow: this.opts.hasShadow,
     webPreferences: {
-      preload: path.join(__dirname, 'preload.js')
-    }
+      preload: path.join(__dirname, 'preload.js'),
+    },
   });
 
   private proxySettings: ProxySettings | null = null;
@@ -89,7 +90,7 @@ export default class BrowserWindowRenderer
     bounds = this.opts.bounds,
     backgroundColor,
     receiveMessageCallback,
-    errorCallback
+    errorCallback,
   }: CreateWindowOptions) {
     const window: BrowserWindowRendererWindow = {
       parentWindowId,
@@ -99,8 +100,8 @@ export default class BrowserWindowRenderer
         parentWindowId && this.opts.renderChildWindowsAsBrowserViews
           ? this.createOrGetPooledBrowserView(windowId, {
               webPreferences: {
-                preload: path.join(__dirname, 'preload.js')
-              }
+                preload: path.join(__dirname, 'preload.js'),
+              },
             })
           : this.createOrGetPooledBrowserWindow(windowId, {
               show: false,
@@ -113,8 +114,8 @@ export default class BrowserWindowRenderer
               transparent: backgroundColor === 'transparent',
               hasShadow: this.opts.hasShadow,
               webPreferences: {
-                preload: path.join(__dirname, 'preload.js')
-              }
+                preload: path.join(__dirname, 'preload.js'),
+              },
             }),
       // If we are creating a child window and renderChildWindowsAsBrowserViews is false that means
       // we are rendering child windows with BrowserWindow. BrowserWindows are positioned absolutely so
@@ -125,7 +126,7 @@ export default class BrowserWindowRenderer
           ? {
               ...bounds,
               x: bounds.x + this.opts.bounds.x,
-              y: bounds.y + this.opts.bounds.y
+              y: bounds.y + this.opts.bounds.y,
             }
           : bounds,
 
@@ -163,7 +164,7 @@ export default class BrowserWindowRenderer
             `Window '${windowId}' render process gone`
           )
         );
-      }
+      },
     };
 
     // Attached crash handlers to skip presentation on error.
@@ -226,7 +227,7 @@ export default class BrowserWindowRenderer
       window.view.setBounds({
         ...window.bounds,
         x: window.bounds.x + this.opts.bounds.x,
-        y: window.bounds.y + this.opts.bounds.y
+        y: window.bounds.y + this.opts.bounds.y,
       });
     } else {
       window.view.setBounds(window.bounds);
@@ -306,7 +307,7 @@ export default class BrowserWindowRenderer
     }
   }
 
-  public sendMessage(windowId: string, message: string) {
+  public sendMessageString(windowId: string, message: string) {
     const window = this.getWindow(windowId);
     if (!window) {
       throw new Error(
@@ -317,6 +318,17 @@ export default class BrowserWindowRenderer
     window.view.webContents.send('electron-main', message);
   }
 
+  public sendMessageObject(windowId: string, type: string, payload?: any) {
+    const window = this.getWindow(windowId);
+    if (!window) {
+      throw new Error(
+        `Failed to send message to window, missing window id '${windowId}'`
+      );
+    }
+
+    window.view.webContents.send('electron-main', { type, payload });
+  }
+
   public muteWindow(windowId: string) {
     const window = this.getWindow(windowId);
     if (!window) {
@@ -436,7 +448,7 @@ export default class BrowserWindowRenderer
         this.logger.info(`Found free browser window from pool`, { windowId });
       } else {
         this.logger.info(`No free browser windows, adding new window to pool`, {
-          windowId
+          windowId,
         });
       }
     }
@@ -486,7 +498,7 @@ export default class BrowserWindowRenderer
         this.logger.info(`Found free browser view from pool`, { windowId });
       } else {
         this.logger.info(`No free browser views, adding new view to pool`, {
-          windowId
+          windowId,
         });
       }
     }
@@ -568,7 +580,7 @@ class WindowPool<T extends BrowserWindow | BrowserView> {
     return {
       total: inuse + free,
       inuse,
-      free
+      free,
     };
   }
 }

package/src/IFrameRenderer.ts

@@ -1,7 +1,7 @@
 import {
   PresentationWindowRenderer,
   CreateWindowOptions,
-  WindowBounds
+  WindowBounds,
 } from './types';
 
 interface IFrameRendererWindow {
@@ -9,7 +9,7 @@ interface IFrameRendererWindow {
   receiveMessageCallback?: (type: string, payload?: any) => void;
 }
 
-const messagePrefix = 'raydiant:';
+const namespace = 'raydiant';
 
 export default class IFrameRenderer implements PresentationWindowRenderer {
   private windows: {
@@ -27,7 +27,7 @@ export default class IFrameRenderer implements PresentationWindowRenderer {
     windowId,
     bounds,
     backgroundColor = 'black',
-    receiveMessageCallback
+    receiveMessageCallback,
   }: CreateWindowOptions) {
     const frame = document.createElement('iframe');
     this.windows[windowId] = { frame, receiveMessageCallback };
@@ -141,7 +141,7 @@ export default class IFrameRenderer implements PresentationWindowRenderer {
     delete this.windows[windowId];
   }
 
-  public sendMessage(windowId: string, message: string) {
+  public sendMessageString(windowId: string, message: string) {
     const window = this.getWindow(windowId);
     if (!window) {
       throw new Error(
@@ -155,7 +155,27 @@ export default class IFrameRenderer implements PresentationWindowRenderer {
       );
     }
 
-    window.frame.contentWindow.postMessage(`${messagePrefix}${message}`, '*');
+    window.frame.contentWindow.postMessage(`${namespace}:${message}`, '*');
+  }
+
+  public sendMessageObject(windowId: string, type: string, payload?: any) {
+    const window = this.getWindow(windowId);
+    if (!window) {
+      throw new Error(
+        `Failed to send message '${type}', missing window id '${windowId}'`
+      );
+    }
+
+    if (!window.frame.contentWindow) {
+      throw new Error(
+        `Failed to send message '${type}', contentWindow missing for '${windowId}'`
+      );
+    }
+
+    window.frame.contentWindow.postMessage(
+      { namespace, windowId, type, payload },
+      '*'
+    );
   }
 
   public muteWindow(windowId: string) {
@@ -190,10 +210,7 @@ export default class IFrameRenderer implements PresentationWindowRenderer {
 
   private globalMessageHandler = (event: MessageEvent) => {
     // Ignore messages that don't start with the message prefix.
-    if (
-      typeof event.data === 'string' &&
-      event.data.startsWith(messagePrefix)
-    ) {
+    if (typeof event.data === 'string' && event.data.startsWith(namespace)) {
       const { windowId, type, payload } = this.deserializeMessage(event.data);
 
       if (!windowId || !type) {
@@ -221,7 +238,7 @@ export default class IFrameRenderer implements PresentationWindowRenderer {
     let type = '';
     let payload: unknown;
 
-    const json = message.substring(messagePrefix.length);
+    const json = message.replace('raydiant:', '');
     try {
       // Messages are sent as json in the format of { type: string, payload: unknown }.
       ({ windowId, type, payload } = JSON.parse(json));