@xiboplayer/cache 0.4.0 → 0.4.1

package/README.md

@@ -11,6 +11,8 @@ Manages media downloads and offline storage for Xibo players:
 - **MD5 verification** — integrity checking with CRC32-based skip optimization
 - **Download queue** — flat queue with barriers for layout-ordered downloading
 - **CacheProxy** — browser-side proxy that communicates with a Service Worker backend
+- **Widget data via enriched RequiredFiles** — RSS/dataset widget data is fetched through server-side enriched RequiredFiles paths (CMS adds download URLs), not via client-side pre-fetching
+- **Dynamic BASE path** — widget HTML `<base>` tag uses a dynamic path within the Service Worker scope for correct relative URL resolution
 
 ## Installation
 

package/docs/CACHE_PROXY_ARCHITECTURE.md

@@ -363,6 +363,18 @@ it('should download and cache files', async () => {
    const blob = await cacheProxy.getFile('media', id);
    ```
 
+## Widget Data Download Flow
+
+Widget data for RSS feeds and dataset widgets is handled server-side. The CMS enriches
+the RequiredFiles response with absolute download URLs for widget data files. These are
+downloaded through the normal CacheProxy/Service Worker pipeline alongside regular media,
+rather than being fetched client-side by the player. This ensures widget data is available
+offline and benefits from the same parallel chunk download and caching infrastructure.
+
+Widget HTML served from cache uses a dynamic `<base>` tag pointing to the Service Worker
+scope path, ensuring relative URLs within widget HTML resolve correctly regardless of the
+player's deployment path.
+
 ### For New Platforms
 
 Simply use CacheProxy from the start:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xiboplayer/cache",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Offline caching and download management with parallel chunk downloads",
   "type": "module",
   "main": "./src/index.js",
@@ -12,7 +12,7 @@
   },
   "dependencies": {
     "spark-md5": "^3.0.2",
-    "@xiboplayer/utils": "0.4.0"
+    "@xiboplayer/utils": "0.4.1"
   },
   "devDependencies": {
     "vitest": "^2.0.0",

package/src/cache-analyzer.js

@@ -56,6 +56,14 @@ export class CacheAnalyzer {
     for (const file of cachedFiles) {
       if (requiredIds.has(String(file.id))) {
         required.push(file);
+      } else if (file.type === 'widget') {
+        // Widget HTML IDs are "layoutId/regionId/widgetId" — check parent layout
+        const parentLayoutId = String(file.id).split('/')[0];
+        if (requiredIds.has(parentLayoutId)) {
+          required.push(file);
+        } else {
+          orphaned.push(file);
+        }
       } else {
         orphaned.push(file);
       }

package/src/cache-analyzer.test.js

@@ -170,6 +170,20 @@ describe('CacheAnalyzer', () => {
       vi.unstubAllGlobals();
     });
 
+    it('should treat widget HTML as required when parent layout is required', async () => {
+      mockCache._addFile({ id: '470', type: 'layout', size: 500, cachedAt: 100 });
+      mockCache._addFile({ id: '470/213/182', type: 'widget', size: 0, cachedAt: 0 });
+      mockCache._addFile({ id: '470/215/184', type: 'widget', size: 0, cachedAt: 0 });
+      mockCache._addFile({ id: '99/10/5', type: 'widget', size: 0, cachedAt: 0 });
+
+      const report = await analyzer.analyze([{ id: '470', type: 'layout' }]);
+
+      // Layout 470 + its 2 widgets = 3 required; widget for layout 99 = orphaned
+      expect(report.files.required).toBe(3);
+      expect(report.files.orphaned).toBe(1);
+      expect(report.orphaned[0].id).toBe('99/10/5');
+    });
+
     it('should handle files with missing size or cachedAt', async () => {
       mockCache._addFile({ id: '1', type: 'media' }); // no size, no cachedAt
 

package/src/download-manager.js

@@ -97,6 +97,20 @@ export function isUrlExpired(url, graceSeconds = 30) {
   return (Date.now() / 1000) >= (expiry - graceSeconds);
 }
 
+/**
+ * Rewrite an absolute CMS URL through the local proxy when running behind
+ * the proxy server (Chromium kiosk or Electron).
+ * Detection: SW/window on localhost:8765 = proxy mode.
+ */
+export function rewriteUrlForProxy(url) {
+  if (!url.startsWith('http')) return url;
+  const loc = typeof self !== 'undefined' ? self.location : undefined;
+  if (!loc || loc.hostname !== 'localhost' || loc.port !== '8765') return url;
+  const parsed = new URL(url);
+  const cmsOrigin = parsed.origin;
+  return `/file-proxy?cms=${encodeURIComponent(cmsOrigin)}&url=${encodeURIComponent(parsed.pathname + parsed.search)}`;
+}
+
 /**
  * DownloadTask - Single HTTP fetch unit
  *
@@ -120,7 +134,7 @@ export class DownloadTask {
     if (isUrlExpired(url)) {
       throw new Error(`URL expired for ${this.fileInfo.type}/${this.fileInfo.id} — waiting for fresh URL from next collection cycle`);
     }
-    return url;
+    return rewriteUrlForProxy(url);
   }
 
   async start() {
@@ -207,7 +221,7 @@ export class FileDownload {
     if (isUrlExpired(url)) {
       throw new Error(`URL expired for ${this.fileInfo.type}/${this.fileInfo.id} — waiting for fresh URL from next collection cycle`);
     }
-    return url;
+    return rewriteUrlForProxy(url);
   }
 
   wait() {

package/src/widget-html.js

@@ -35,8 +35,8 @@ export async function cacheWidgetHtml(layoutId, regionId, mediaId, html) {
   const cache = await caches.open(CACHE_NAME);
 
   // Inject <base> tag to fix relative paths for widget dependencies
-  // Widget HTML has relative paths like "bundle.min.js" that should resolve to /player/cache/media/
-  const baseTag = '<base href="/player/cache/media/">';
+  // Widget HTML has relative paths like "bundle.min.js" that should resolve to cache/media/
+  const baseTag = `<base href="${BASE}/cache/media/">`;
   let modifiedHtml = html;
 
   // Insert base tag after <head> opening tag
@@ -80,7 +80,7 @@ export async function cacheWidgetHtml(layoutId, regionId, mediaId, html) {
     `hostAddress: "${BASE}/ic"`
   );
 
-  log.info('Injected base tag and rewrote CMS URLs in widget HTML');
+  log.info('Injected base tag and rewrote CMS/data URLs in widget HTML');
 
   // Construct full URL for cache storage
   const cacheUrl = new URL(cacheKey, window.location.origin);