@raydiant/playlist-window-manager 0.0.0-test-1

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

@@ -0,0 +1,142 @@
+export interface Playlist {
+    id: string;
+}
+export interface Presentation {
+    id: string;
+    name: string;
+    applicationDeploymentId: string;
+    themeId: string | null;
+    applicationVariables: {
+        [key: string]: any;
+    };
+    duration: number;
+    r: {
+        resource: {
+            updatedAt: string;
+            createdAt: string;
+        };
+        presentationsPlaylists: Array<{
+            playlistId: string;
+        }>;
+    };
+}
+export interface ApplicationVersion {
+    id: string;
+    name: string;
+    applicationId: string;
+    embeddedUrlFormat: string | null;
+    configurableDuration: boolean;
+    sourceUrl: string | null;
+    presentationProperties: Array<{
+        name: string;
+        type: string;
+        encode?: boolean;
+    }>;
+}
+export interface Font {
+    id: string;
+    name: string;
+    weight: string;
+    fileUpload: {
+        url: string;
+    };
+}
+export interface Theme {
+    id: string;
+    name: string;
+    backgroundColor: string;
+    backgroundImage: string;
+    backgroundImagePortrait: string;
+    headingTextColor: string;
+    headingFont: string;
+    heading2TextColor: string;
+    heading2Font: string;
+    bodyTextColor: string;
+    bodyFont: string;
+    borderColor: string;
+    headingFontNew: Font | null;
+    heading2FontNew: Font | null;
+    bodyFontNew: Font | null;
+    backgroundImageFileUpload: {
+        url: string;
+    } | null;
+    backgroundScale: 'fit' | 'fill' | null;
+}
+export interface Device {
+    id: string;
+    name: string | null;
+}
+export interface WindowBounds {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export interface WorkerState {
+    [key: string]: any;
+}
+export interface PreviewState {
+    inputs: Record<string, any>;
+}
+export interface CreateWindowOptions {
+    windowId: string;
+    parentWindowId?: string;
+    bounds?: WindowBounds;
+    backgroundColor?: string;
+    receiveMessageCallback?: (type: string, payload?: any) => void;
+    errorCallback: (err: any) => void;
+}
+export interface Logger {
+    debug(message: any, context?: {
+        [key: string]: any;
+    }): void;
+    info(message: any, context?: {
+        [key: string]: any;
+    }): void;
+    warn(message: any, context?: {
+        [key: string]: any;
+    }): void;
+    error(message: any, context?: {
+        [key: string]: any;
+    }): void;
+}
+export interface PresentationWindowRenderer {
+    createWindow(options: CreateWindowOptions): void;
+    loadWindow(windowId: string, url: string): Promise<void>;
+    updateWindowBounds(windowId: string, bounds: WindowBounds): void;
+    showWindow(windowId: string, isFocused: boolean): void;
+    hideWindow(windowId: string): void;
+    removeWindow(windowId: string): Promise<void>;
+    sendMessageString(windowId: string, message: string): void;
+    sendMessageObject(windowId: string, type: string, payload?: any): void;
+    muteWindow(windowId: string): void;
+    unMuteWindow(windowId: string): void;
+}
+export interface OpenChildWindowOptions {
+    windowId: string;
+    playlistId: string;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    isFocused: boolean;
+    isMuted: boolean;
+    theme?: Theme;
+}
+export type Path = Array<string | number>;
+export interface BuilderState {
+    inputs: InputState[];
+    profileId?: string;
+}
+export interface InputState {
+    path: Path;
+    state: any;
+}
+export interface EmbeddedAppMetadata {
+    renderMode: 'preview' | 'live';
+}
+export interface AnalyticsEvent {
+    type: string;
+    source: string;
+    productCategory?: string | null;
+}

package/build/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/jest.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  roots: ['<rootDir>/src'],
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest'
+  }
+};

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@raydiant/playlist-window-manager",
+  "version": "0.0.0-test-1",
+  "description": "Window manager for playlist playback.",
+  "main": "build/index.js",
+  "scripts": {
+    "build": "rm -rf build && tsc",
+    "lint": "eslint -c ./.eslintrc **/*.ts",
+    "tsc": "tsc",
+    "test": "jest",
+    "deploy": "sh tasks/npm-publish.sh"
+  },
+  "dependencies": {
+    "fast-deep-equal": "^3.1.3",
+    "@raydiant/playlist-rule-engine": "3.2.2",
+    "raydiant-kit": "4.7.3",
+    "uuid": "^8.3.0",
+    "eventemitter3": "^4.0.7"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.5.5",
+    "@types/jschannel": "^1.0.1",
+    "@types/jest": "^24.0.15",
+    "@types/uuid": "8.3.0",
+    "electron": "10.1.5",
+    "jest": "^24.8.0",
+    "ts-jest": "^24.0.2",
+    "typescript": "^4.1.2"
+  }
+}

package/src/BrowserViewRenderer.ts

@@ -0,0 +1,182 @@
+import * as path from 'path';
+import { BrowserWindow, BrowserView, ipcMain, IpcMainEvent } from 'electron';
+import {
+  PresentationWindowRenderer,
+  CreateWindowOptions,
+  WindowBounds,
+} from './types';
+
+interface BrowserViewRendererWindow {
+  view: BrowserView;
+  bounds: WindowBounds;
+  receiveMessageCallback: (
+    event: IpcMainEvent,
+    type: string,
+    payload?: any
+  ) => void;
+}
+
+export default class BrowserViewRenderer implements PresentationWindowRenderer {
+  private windows: {
+    [windowId: string]: BrowserViewRendererWindow;
+  } = {};
+
+  constructor(
+    private mainWindow: BrowserWindow,
+    private offscreenWindow: BrowserWindow
+  ) {}
+
+  public async createWindow({
+    windowId,
+    parentWindowId,
+    bounds,
+    backgroundColor,
+    receiveMessageCallback,
+  }: CreateWindowOptions) {
+    // TODO log bounds
+
+    const window = {
+      view: new BrowserView({
+        webPreferences: {
+          preload: path.join(__dirname, 'preload.js'),
+        },
+      }),
+
+      bounds: bounds || { ...this.mainWindow.getBounds(), x: 0, y: 0 },
+
+      receiveMessageCallback: (
+        _: IpcMainEvent,
+        type: string,
+        payload?: any
+      ) => {
+        if (receiveMessageCallback) {
+          receiveMessageCallback(type, payload);
+        }
+      },
+    };
+
+    this.windows[windowId] = window;
+
+    ipcMain.on(windowId, window.receiveMessageCallback);
+
+    this.offscreenWindow.addBrowserView(window.view);
+    // TODO log bounds
+    window.view.setBounds(window.bounds);
+
+    if (backgroundColor) {
+      window.view.setBackgroundColor(backgroundColor);
+    }
+
+    // The main window browserviews should auto size with the container but child window
+    // browser views have their own resize handlers and are updated via updateWindowBounds.
+    if (!parentWindowId) {
+      window.view.setAutoResize({
+        width: true,
+        height: true,
+      });
+    }
+  }
+
+  public async loadWindow(windowId: string, url: string) {
+    const window = this.getWindow(windowId);
+    if (!window) {
+      throw new Error(`Failed to load window, missing window id '${windowId}'`);
+    }
+
+    await window.view.webContents.loadURL(url);
+  }
+
+  public updateWindowBounds(windowId: string, bounds: WindowBounds) {
+    const window = this.getWindow(windowId);
+    if (!window) {
+      throw new Error(
+        `Failed to update window bounds, missing window id '${windowId}'`
+      );
+    }
+    // TODO log bounds
+    window.bounds = bounds;
+    window.view.setBounds(window.bounds);
+  }
+
+  public showWindow(windowId: string, isFocused: boolean) {
+    const window = this.getWindow(windowId);
+    if (!window) {
+      throw new Error(`Failed to show window, missing window id '${windowId}'`);
+    }
+
+    this.mainWindow.addBrowserView(window.view);
+
+    if (isFocused) {
+      // The setTimeout is required to set focus after the BrowserView has
+      // been added to the parent BrowserWindow.
+      setTimeout(() => window.view.webContents.focus(), 0);
+    }
+  }
+
+  public hideWindow(windowId: string) {
+    const window = this.getWindow(windowId);
+    if (!window) {
+      throw new Error(`Failed to hide window, missing window id '${windowId}'`);
+    }
+
+    this.offscreenWindow.addBrowserView(window.view);
+  }
+
+  public async removeWindow(windowId: string) {
+    const window = this.getWindow(windowId);
+    if (!window) {
+      throw new Error(`Failed to hide window, missing window id '${windowId}'`);
+    }
+
+    this.hideWindow(windowId);
+    window.view.webContents.loadURL('about:blank');
+    ipcMain.off(windowId, window.receiveMessageCallback);
+    delete this.windows[windowId];
+  }
+
+  public sendMessageString(windowId: string, message: string) {
+    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', 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) {
+      throw new Error(`Failed to mute window, missing window id '${windowId}'`);
+    }
+
+    window.view.webContents.setAudioMuted(true);
+  }
+
+  public unMuteWindow(windowId: string) {
+    const window = this.getWindow(windowId);
+    if (!window) {
+      throw new Error(
+        `Failed to unmute window, missing window id '${windowId}'`
+      );
+    }
+
+    window.view.webContents.setAudioMuted(false);
+  }
+
+  private getWindow(windowId: string): BrowserViewRendererWindow | null {
+    return this.windows[windowId];
+  }
+}