@xiboplayer/xmr 0.3.6 → 0.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xiboplayer/xmr",
-  "version": "0.3.6",
+  "version": "0.4.0",
   "description": "XMR WebSocket client for real-time Xibo CMS commands",
   "type": "module",
   "main": "./src/index.js",
@@ -9,7 +9,7 @@
   },
   "dependencies": {
     "@xibosignage/xibo-communication-framework": "^0.0.6",
-    "@xiboplayer/utils": "0.3.6"
+    "@xiboplayer/utils": "0.4.0"
   },
   "devDependencies": {
     "vitest": "^2.0.0"

package/src/xmr-wrapper.js

@@ -156,10 +156,18 @@ export class XmrWrapper {
     });
 
     // CMS command: Change Layout
-    this.xmr.on('changeLayout', async (layoutId) => {
-      log.info('Received changeLayout command:', layoutId);
+    // Payload may be a layoutId string or an object with { layoutId, duration, downloadRequired, changeMode }
+    this.xmr.on('changeLayout', async (data) => {
+      const layoutId = typeof data === 'object' ? (data.layoutId || data) : data;
+      const duration = typeof data === 'object' ? (parseInt(data.duration) || 0) : 0;
+      const changeMode = typeof data === 'object' ? (data.changeMode || 'replace') : 'replace';
+      log.info('Received changeLayout command:', layoutId, duration ? `duration=${duration}s` : '', changeMode !== 'replace' ? `mode=${changeMode}` : '');
       try {
-        await this.player.changeLayout(layoutId);
+        if (typeof data === 'object' && data.downloadRequired === true) {
+          log.info('changeLayout: downloadRequired — triggering collection first');
+          await this.player.collect();
+        }
+        await this.player.changeLayout(layoutId, { duration, changeMode });
         log.debug('changeLayout completed successfully');
       } catch (error) {
         log.error('changeLayout failed:', error);
@@ -167,10 +175,17 @@ export class XmrWrapper {
     });
 
     // CMS command: Overlay Layout
-    this.xmr.on('overlayLayout', async (layoutId) => {
-      log.info('Received overlayLayout command:', layoutId);
+    // Payload may be a layoutId string or an object with { layoutId, duration, downloadRequired }
+    this.xmr.on('overlayLayout', async (data) => {
+      const layoutId = typeof data === 'object' ? (data.layoutId || data) : data;
+      const duration = typeof data === 'object' ? (parseInt(data.duration) || 0) : 0;
+      log.info('Received overlayLayout command:', layoutId, duration ? `duration=${duration}s` : '');
       try {
-        await this.player.overlayLayout(layoutId);
+        if (typeof data === 'object' && data.downloadRequired === true) {
+          log.info('overlayLayout: downloadRequired — triggering collection first');
+          await this.player.collect();
+        }
+        await this.player.overlayLayout(layoutId, { duration });
         log.debug('overlayLayout completed successfully');
       } catch (error) {
         log.error('overlayLayout failed:', error);
@@ -200,10 +215,14 @@ export class XmrWrapper {
     });
 
     // CMS command: Execute Command
+    // Resolve command from local display settings (from RegisterDisplay), not from XMR payload
     this.xmr.on('commandAction', async (data) => {
-      log.info('Received commandAction command:', data);
+      const commandCode = data?.commandCode || data;
+      log.info('Received commandAction command:', commandCode);
       try {
-        await this.player.executeCommand(data?.commandCode || data, data?.commands);
+        // Use local commands from RegisterDisplay (stored on player), not XMR payload commands
+        const localCommands = this.player.displayCommands || data?.commands;
+        await this.player.executeCommand(commandCode, localCommands);
         log.debug('commandAction completed successfully');
       } catch (error) {
         log.error('commandAction failed:', error);
@@ -232,9 +251,9 @@ export class XmrWrapper {
       }
     });
 
-    // CMS command: Rekey (RSA key pair rotation)
-    this.xmr.on('rekey', async () => {
-      log.info('Received rekey command - rotating RSA key pair');
+    // CMS command: Rekey (RSA key pair rotation) — spec event name is 'rekeyAction'
+    this.xmr.on('rekeyAction', async () => {
+      log.info('Received rekeyAction command - rotating RSA key pair');
       try {
         this.config.data.xmrPubKey = '';
         this.config.data.xmrPrivKey = '';

package/src/xmr-wrapper.test.js

@@ -287,7 +287,7 @@ describe('XmrWrapper', () => {
         xmrInstance.simulateCommand('changeLayout', 'layout-123');
         await vi.runAllTimersAsync();
 
-        expect(mockPlayer.changeLayout).toHaveBeenCalledWith('layout-123');
+        expect(mockPlayer.changeLayout).toHaveBeenCalledWith('layout-123', { duration: 0, changeMode: 'replace' });
       });
 
       it('should handle changeLayout failure gracefully', async () => {
@@ -310,7 +310,7 @@ describe('XmrWrapper', () => {
         mockConfig.data.xmrPubKey = 'old-pub-key';
         mockConfig.data.xmrPrivKey = 'old-priv-key';
 
-        xmrInstance.simulateCommand('rekey');
+        xmrInstance.simulateCommand('rekeyAction');
         await vi.runAllTimersAsync();
 
         // Should clear old keys before regenerating
@@ -326,7 +326,7 @@ describe('XmrWrapper', () => {
         mockConfig.ensureXmrKeyPair.mockRejectedValue(new Error('Key generation failed'));
         const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(() => {});
 
-        xmrInstance.simulateCommand('rekey');
+        xmrInstance.simulateCommand('rekeyAction');
         await vi.runAllTimersAsync();
 
         expect(consoleErrorSpy).toHaveBeenCalledWith(
@@ -435,7 +435,7 @@ describe('XmrWrapper', () => {
         xmrInstance.simulateCommand('overlayLayout', 'overlay-layout-456');
         await vi.runAllTimersAsync();
 
-        expect(mockPlayer.overlayLayout).toHaveBeenCalledWith('overlay-layout-456');
+        expect(mockPlayer.overlayLayout).toHaveBeenCalledWith('overlay-layout-456', { duration: 0 });
       });
 
       it('should handle overlayLayout failure gracefully', async () => {
@@ -745,7 +745,7 @@ describe('XmrWrapper', () => {
 
       expect(mockPlayer.collect).toHaveBeenCalled();
       expect(mockPlayer.captureScreenshot).toHaveBeenCalled();
-      expect(mockPlayer.changeLayout).toHaveBeenCalledWith('layout-123');
+      expect(mockPlayer.changeLayout).toHaveBeenCalledWith('layout-123', { duration: 0, changeMode: 'replace' });
     });
 
     it('should handle rapid connect/disconnect cycles', async () => {