@xiboplayer/core 0.1.0

package/docs/README.md

@@ -0,0 +1,92 @@
+# @xiboplayer/core Documentation
+
+**Player core orchestration and lifecycle management.**
+
+## 📖 Contents
+
+- [ARCHITECTURE.md](ARCHITECTURE.md) - Core system architecture and design
+
+## Overview
+
+The `@xiboplayer/core` package provides the foundational player logic:
+
+- **Player lifecycle** - Initialization, start, stop, restart
+- **Module orchestration** - Coordinates renderer, cache, schedule, XMDS
+- **Event system** - Pub/sub event bus for inter-module communication
+- **Configuration** - Player configuration management
+- **Error handling** - Centralized error management
+
+## Installation
+
+```bash
+npm install @xiboplayer/core
+```
+
+## Basic Usage
+
+```javascript
+import { PlayerCore } from '@xiboplayer/core';
+
+const player = new PlayerCore({
+  cmsUrl: 'https://cms.example.com',
+  displayId: 123,
+  hardwareKey: 'abc123'
+});
+
+await player.initialize();
+player.start();
+```
+
+## Architecture
+
+See: [ARCHITECTURE.md](ARCHITECTURE.md) for detailed system design.
+
+### Key Components
+
+- **PlayerCore** - Main orchestrator
+- **EventEmitter** - Event bus implementation
+- **Config** - Configuration management
+- **Logger** - Structured logging
+
+## API Reference
+
+### PlayerCore
+
+```javascript
+class PlayerCore {
+  constructor(config)
+  async initialize()
+  start()
+  stop()
+  restart()
+  on(event, callback)
+  emit(event, data)
+}
+```
+
+### Events
+
+- `player:ready` - Player initialized and ready
+- `player:error` - Player encountered error
+- `layout:start` - Layout playback started
+- `layout:end` - Layout playback ended
+- `media:download` - Media file downloaded
+
+## Dependencies
+
+- `@xiboplayer/utils` - Shared utilities
+- `@xiboplayer/xmds` - CMS communication (peer)
+- `@xiboplayer/cache` - Offline storage (peer)
+- `@xiboplayer/renderer` - Layout rendering (peer)
+- `@xiboplayer/schedule` - Campaign scheduling (peer)
+
+## Related Packages
+
+- [@xiboplayer/renderer](../../renderer/docs/) - Rendering engine
+- [@xiboplayer/cache](../../cache/docs/) - Cache management
+- [@xiboplayer/schedule](../../schedule/docs/) - Scheduling logic
+
+---
+
+**Package Version**: 1.0.0
+**Last Updated**: 2026-02-10

package/examples/dayparting-schedule-example.json

@@ -0,0 +1,190 @@
+{
+  "description": "Example schedule demonstrating dayparting (recurring schedules) functionality",
+  "note": "This schedule shows realistic dayparting scenarios for a digital signage display",
+
+  "schedule": {
+    "default": "0",
+
+    "layouts": [
+      {
+        "description": "Main menu - Weekday business hours",
+        "file": "100",
+        "priority": 5,
+        "fromdt": "2025-01-30T09:00:00Z",
+        "todt": "2025-01-30T17:00:00Z",
+        "recurrenceType": "Week",
+        "recurrenceRepeatsOn": "1,2,3,4,5",
+        "comment": "Shows Monday-Friday, 9am-5pm. Base content during business hours."
+      },
+      {
+        "description": "Weekend menu",
+        "file": "101",
+        "priority": 5,
+        "fromdt": "2025-01-30T10:00:00Z",
+        "todt": "2025-01-30T18:00:00Z",
+        "recurrenceType": "Week",
+        "recurrenceRepeatsOn": "6,7",
+        "comment": "Shows Saturday-Sunday, 10am-6pm. Different hours on weekends."
+      },
+      {
+        "description": "Lunch specials - Mon/Wed/Fri only",
+        "file": "200",
+        "priority": 10,
+        "fromdt": "2025-01-30T12:00:00Z",
+        "todt": "2025-01-30T14:00:00Z",
+        "recurrenceType": "Week",
+        "recurrenceRepeatsOn": "1,3,5",
+        "comment": "Higher priority. Overrides main menu during lunch on Mon/Wed/Fri."
+      },
+      {
+        "description": "Night mode - After hours",
+        "file": "300",
+        "priority": 3,
+        "fromdt": "2025-01-30T18:00:00Z",
+        "todt": "2025-01-30T08:00:00Z",
+        "recurrenceType": "Week",
+        "recurrenceRepeatsOn": "1,2,3,4,5,6,7",
+        "comment": "Crosses midnight. Shows 6pm-8am daily. Lower priority than business hours."
+      },
+      {
+        "description": "Tuesday special promotion",
+        "file": "400",
+        "priority": 15,
+        "fromdt": "2025-01-30T09:00:00Z",
+        "todt": "2025-01-30T17:00:00Z",
+        "recurrenceType": "Week",
+        "recurrenceRepeatsOn": "2",
+        "comment": "Highest priority. Takes over entire Tuesday."
+      },
+      {
+        "description": "Year-end sale - Limited duration recurring",
+        "file": "500",
+        "priority": 12,
+        "fromdt": "2025-01-30T10:00:00Z",
+        "todt": "2025-01-30T20:00:00Z",
+        "recurrenceType": "Week",
+        "recurrenceRepeatsOn": "6,7",
+        "recurrenceRange": "2025-12-31T23:59:59Z",
+        "comment": "Recurring on weekends, but only until end of 2025."
+      }
+    ],
+
+    "campaigns": [
+      {
+        "description": "Morning news campaign - Weekday mornings",
+        "id": "1",
+        "priority": 8,
+        "fromdt": "2025-01-30T08:00:00Z",
+        "todt": "2025-01-30T10:00:00Z",
+        "recurrenceType": "Week",
+        "recurrenceRepeatsOn": "1,2,3,4,5",
+        "layouts": [
+          { "file": "600", "comment": "News headlines" },
+          { "file": "601", "comment": "Weather forecast" },
+          { "file": "602", "comment": "Traffic updates" }
+        ],
+        "comment": "Cycles through 3 layouts during morning hours on weekdays."
+      },
+      {
+        "description": "Happy hour campaign - Thurs-Fri evenings",
+        "id": "2",
+        "priority": 11,
+        "fromdt": "2025-01-30T17:00:00Z",
+        "todt": "2025-01-30T19:00:00Z",
+        "recurrenceType": "Week",
+        "recurrenceRepeatsOn": "4,5",
+        "layouts": [
+          { "file": "700", "comment": "Drink specials" },
+          { "file": "701", "comment": "Appetizer deals" }
+        ],
+        "comment": "Shows on Thursday and Friday evenings only."
+      }
+    ]
+  },
+
+  "scenarios": {
+    "monday_noon": {
+      "time": "Monday, 12:30 PM",
+      "active_schedules": [
+        "file 200 (Lunch specials - priority 10)"
+      ],
+      "explanation": "Lunch special has higher priority than main menu"
+    },
+
+    "monday_2pm": {
+      "time": "Monday, 2:00 PM",
+      "active_schedules": [
+        "file 100 (Main menu - priority 5)"
+      ],
+      "explanation": "After lunch hours, back to main menu"
+    },
+
+    "tuesday_10am": {
+      "time": "Tuesday, 10:00 AM",
+      "active_schedules": [
+        "file 400 (Tuesday special - priority 15)"
+      ],
+      "explanation": "Tuesday special has highest priority, takes over all day"
+    },
+
+    "wednesday_noon": {
+      "time": "Wednesday, 12:30 PM",
+      "active_schedules": [
+        "file 200 (Lunch specials - priority 10)"
+      ],
+      "explanation": "Lunch special active on Mon/Wed/Fri"
+    },
+
+    "thursday_5pm": {
+      "time": "Thursday, 5:30 PM",
+      "active_schedules": [
+        "campaign 2 (Happy hour - priority 11)",
+        "layouts: [700, 701]"
+      ],
+      "explanation": "Happy hour campaign active Thu-Fri evenings"
+    },
+
+    "friday_9am": {
+      "time": "Friday, 9:00 AM",
+      "active_schedules": [
+        "campaign 1 (Morning news - priority 8)"
+      ],
+      "explanation": "Morning news campaign during 8-10am on weekdays"
+    },
+
+    "saturday_2pm": {
+      "time": "Saturday, 2:00 PM",
+      "active_schedules": [
+        "file 500 (Year-end sale - priority 12)",
+        "file 101 (Weekend menu - priority 5)"
+      ],
+      "explanation": "Year-end sale wins (priority 12 > 5)"
+    },
+
+    "sunday_10pm": {
+      "time": "Sunday, 10:00 PM",
+      "active_schedules": [
+        "file 300 (Night mode - priority 3)"
+      ],
+      "explanation": "After weekend hours, shows night mode"
+    },
+
+    "monday_11pm": {
+      "time": "Monday, 11:00 PM",
+      "active_schedules": [
+        "file 300 (Night mode - priority 3)"
+      ],
+      "explanation": "Night mode handles midnight crossing (6pm-8am)"
+    }
+  },
+
+  "priority_notes": [
+    "Priority 15: Tuesday special (highest)",
+    "Priority 12: Year-end sale",
+    "Priority 11: Happy hour campaign",
+    "Priority 10: Lunch specials",
+    "Priority 8: Morning news campaign",
+    "Priority 5: Main/weekend menus",
+    "Priority 3: Night mode (lowest active)"
+  ]
+}

package/index.html

@@ -0,0 +1,262 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>Xibo Player</title>
+  <link rel="manifest" href="/manifest.json">
+  <style>
+    * {
+      margin: 0;
+      padding: 0;
+      box-sizing: border-box;
+    }
+
+    html, body {
+      width: 100%;
+      height: 100%;
+      overflow: hidden;
+      background-color: #000;
+      font-family: sans-serif;
+    }
+
+    #layout-container {
+      position: absolute;
+      top: 0;
+      left: 0;
+      width: 100%;
+      height: 100%;
+      overflow: hidden;
+    }
+
+    #message {
+      position: absolute;
+      top: 50%;
+      left: 50%;
+      transform: translate(-50%, -50%);
+      padding: 20px 40px;
+      background: rgba(0, 0, 0, 0.9);
+      color: white;
+      font-size: 24px;
+      text-align: center;
+      border-radius: 8px;
+      display: none;
+      z-index: 9999;
+    }
+
+    #download-progress {
+      display: none;
+      position: fixed;
+      bottom: 20px;
+      right: 20px;
+      background: rgba(0,0,0,0.95);
+      padding: 16px;
+      border-radius: 8px;
+      min-width: 320px;
+      z-index: 10000;
+      box-shadow: 0 4px 12px rgba(0,0,0,0.5);
+    }
+
+    #download-progress .filename {
+      font-size: 14px;
+      margin-bottom: 8px;
+      color: #ccc;
+      white-space: nowrap;
+      overflow: hidden;
+      text-overflow: ellipsis;
+    }
+
+    #download-progress .progress-bar {
+      width: 100%;
+      height: 6px;
+      background: #333;
+      border-radius: 3px;
+      overflow: hidden;
+      margin-bottom: 6px;
+    }
+
+    #download-progress .progress-fill {
+      height: 100%;
+      background: linear-gradient(90deg, #4CAF50, #66BB6A);
+      transition: width 0.3s ease;
+      border-radius: 3px;
+    }
+
+    #download-progress .progress-text {
+      font-size: 12px;
+      color: #999;
+      display: flex;
+      justify-content: space-between;
+    }
+
+    #network-panel {
+      display: none;
+      position: fixed;
+      top: 50%;
+      left: 50%;
+      transform: translate(-50%, -50%);
+      background: rgba(0,0,0,0.98);
+      padding: 24px;
+      border-radius: 12px;
+      width: 90%;
+      max-width: 800px;
+      max-height: 80%;
+      overflow-y: auto;
+      z-index: 10001;
+      box-shadow: 0 8px 32px rgba(0,0,0,0.9);
+      border: 1px solid #333;
+    }
+
+    #network-panel h2 {
+      margin: 0 0 16px 0;
+      font-size: 18px;
+      border-bottom: 1px solid #444;
+      padding-bottom: 12px;
+      color: #fff;
+    }
+
+    #network-panel .close {
+      position: absolute;
+      top: 16px;
+      right: 20px;
+      background: none;
+      border: none;
+      color: #999;
+      font-size: 28px;
+      cursor: pointer;
+      padding: 0;
+      line-height: 1;
+    }
+
+    #network-panel .close:hover {
+      color: white;
+    }
+
+    #network-panel .activity-list {
+      list-style: none;
+      padding: 0;
+      margin: 0;
+      font-size: 13px;
+      font-family: monospace;
+    }
+
+    #network-panel .activity-list li {
+      padding: 10px;
+      border-bottom: 1px solid #222;
+      display: grid;
+      grid-template-columns: 80px 1fr 100px 80px;
+      gap: 12px;
+      align-items: center;
+    }
+
+    #network-panel .activity-list li:hover {
+      background: rgba(255,255,255,0.05);
+    }
+
+    #network-panel .time {
+      color: #666;
+      font-size: 11px;
+    }
+
+    #network-panel .file {
+      color: #fff;
+      overflow: hidden;
+      text-overflow: ellipsis;
+      white-space: nowrap;
+    }
+
+    #network-panel .size {
+      color: #999;
+      text-align: right;
+      font-size: 11px;
+    }
+
+    #network-panel .status {
+      padding: 4px 8px;
+      border-radius: 4px;
+      font-size: 10px;
+      font-weight: bold;
+      text-align: center;
+      text-transform: uppercase;
+    }
+
+    #network-panel .status.success {
+      background: #2e7d32;
+      color: white;
+    }
+
+    #network-panel .status.error {
+      background: #c62828;
+      color: white;
+    }
+
+    #network-panel .status.loading {
+      background: #1976d2;
+      color: white;
+    }
+
+    #network-panel .empty {
+      text-align: center;
+      padding: 40px;
+      color: #666;
+    }
+  </style>
+</head>
+<body>
+  <div id="layout-container"></div>
+  <div id="message"></div>
+
+  <!-- Download Progress Indicator -->
+  <div id="download-progress">
+    <div class="filename" id="progress-filename">Downloading...</div>
+    <div class="progress-bar">
+      <div class="progress-fill" id="progress-fill" style="width: 0%"></div>
+    </div>
+    <div class="progress-text">
+      <span id="progress-percent">0%</span>
+      <span id="progress-size">0 / 0 MB</span>
+    </div>
+  </div>
+
+  <!-- Network Activity Panel (Ctrl+N to toggle) -->
+  <div id="network-panel">
+    <button class="close" id="close-network">&times;</button>
+    <h2>📡 Network Activity</h2>
+    <ul class="activity-list" id="activity-list">
+      <li class="empty">No network activity yet</li>
+    </ul>
+  </div>
+
+  <script type="module" src="/src/main.js"></script>
+  <script>
+    // Register service worker
+    if ('serviceWorker' in navigator) {
+      navigator.serviceWorker.register('/player/sw.js', { scope: '/player/' })
+        .then(reg => {
+          console.log('[SW] Registered:', reg.scope);
+          console.log('[SW] State:', reg.active ? reg.active.state : 'installing');
+
+          // Force update on page load to get latest SW
+          reg.update();
+
+          // Log when SW updates
+          reg.addEventListener('updatefound', () => {
+            console.log('[SW] Update found, installing new version...');
+          });
+        })
+        .catch(err => console.error('[SW] Registration failed:', err));
+
+      // Check if SW is controlling this page
+      navigator.serviceWorker.ready.then(reg => {
+        if (navigator.serviceWorker.controller) {
+          console.log('[SW] Controlling page:', navigator.serviceWorker.controller.scriptURL);
+        } else {
+          console.warn('[SW] NOT controlling page - hard refresh may be needed');
+        }
+      });
+    } else {
+      console.warn('[SW] Service workers not supported');
+    }
+  </script>
+</body>
+</html>

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@xiboplayer/core",
+  "version": "0.1.0",
+  "description": "Xibo Player core orchestration and lifecycle management",
+  "type": "module",
+  "main": "./src/index.js",
+  "exports": {
+    ".": "./src/index.js",
+    "./player-core": "./src/player-core.js"
+  },
+  "dependencies": {
+    "@xibosignage/xibo-communication-framework": "^0.0.6",
+    "nanoevents": "^9.1.0",
+    "@xiboplayer/utils": "0.1.0"
+  },
+  "peerDependencies": {
+    "@xiboplayer/renderer": "0.1.0",
+    "@xiboplayer/cache": "0.1.0",
+    "@xiboplayer/xmds": "0.1.0",
+    "@xiboplayer/schedule": "0.1.0"
+  },
+  "devDependencies": {
+    "vite": "^7.3.1",
+    "vitest": "^2.0.0",
+    "jsdom": "^25.0.0",
+    "@vitest/ui": "^2.0.0",
+    "@vitest/coverage-v8": "^2.0.0"
+  },
+  "keywords": [
+    "xibo",
+    "digital-signage",
+    "player",
+    "core",
+    "orchestration"
+  ],
+  "author": "Pau Aliagas <linuxnow@gmail.com>",
+  "license": "AGPL-3.0-or-later",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/xibo-players/xiboplayer.git",
+    "directory": "packages/core"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview",
+    "proxy": "node proxy.js",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:ui": "vitest --ui",
+    "test:coverage": "vitest run --coverage"
+  }
+}

package/proxy.js

@@ -0,0 +1,72 @@
+/**
+ * Simple CORS proxy for development
+ * Usage: CMS_URL=https://your-cms node proxy.js
+ * Then set CMS address to http://localhost:8080 in the player
+ */
+
+import http from 'http';
+import https from 'https';
+import { URL } from 'url';
+
+const ACTUAL_CMS = process.env.CMS_URL || 'http://your-cms-address';
+const PORT = 8080;
+
+const server = http.createServer(async (req, res) => {
+  console.log(`[Proxy] ${req.method} ${req.url}`);
+
+  // Handle OPTIONS preflight
+  if (req.method === 'OPTIONS') {
+    res.writeHead(204, {
+      'Access-Control-Allow-Origin': '*',
+      'Access-Control-Allow-Methods': 'POST, GET, OPTIONS',
+      'Access-Control-Allow-Headers': 'Content-Type'
+    });
+    res.end();
+    return;
+  }
+
+  const targetUrl = new URL(ACTUAL_CMS + req.url);
+  const isHttps = targetUrl.protocol === 'https:';
+
+  console.log(`[Proxy] Forwarding to ${targetUrl.href}`);
+
+  // Choose http or https module
+  const httpModule = isHttps ? https : http;
+
+  // Forward request to actual CMS
+  const options = {
+    method: req.method,
+    hostname: targetUrl.hostname,
+    port: targetUrl.port || (isHttps ? 443 : 80),
+    path: targetUrl.pathname + targetUrl.search,
+    headers: {
+      ...req.headers,
+      host: targetUrl.host
+    }
+  };
+
+  const proxyReq = httpModule.request(options, (proxyRes) => {
+    // Add CORS headers
+    res.writeHead(proxyRes.statusCode, {
+      ...proxyRes.headers,
+      'Access-Control-Allow-Origin': '*',
+      'Access-Control-Allow-Methods': 'POST, GET, OPTIONS',
+      'Access-Control-Allow-Headers': 'Content-Type'
+    });
+    proxyRes.pipe(res);
+  });
+
+  proxyReq.on('error', (err) => {
+    console.error('[Proxy] Error:', err);
+    res.writeHead(500);
+    res.end('Proxy error');
+  });
+
+  req.pipe(proxyReq);
+});
+
+server.listen(PORT, () => {
+  console.log(`[Proxy] Running on http://localhost:${PORT}`);
+  console.log(`[Proxy] Forwarding to ${ACTUAL_CMS}`);
+  console.log('\nIn the player, set CMS address to: http://localhost:8080');
+});

package/public/manifest.json

@@ -0,0 +1,22 @@
+{
+  "name": "Xibo Player",
+  "short_name": "Xibo",
+  "description": "Free Xibo-compatible digital signage player",
+  "start_url": "/player/",
+  "display": "fullscreen",
+  "orientation": "any",
+  "background_color": "#000000",
+  "theme_color": "#000000",
+  "icons": [
+    {
+      "src": "/icon-192.png",
+      "sizes": "192x192",
+      "type": "image/png"
+    },
+    {
+      "src": "/icon-512.png",
+      "sizes": "512x512",
+      "type": "image/png"
+    }
+  ]
+}