@xiboplayer/cache 0.5.7 → 0.5.9

package/README.md

@@ -1,19 +1,23 @@
 # @xiboplayer/cache
 
-**Offline caching and download management with parallel chunk downloads.**
+**Offline caching and download management with durable filesystem storage.**
 
 ## Overview
 
 Manages media downloads and offline storage for Xibo players:
 
+- **StoreClient** — pure REST client for reading/writing content in the ContentStore (filesystem via proxy)
+- **DownloadClient** — Service Worker postMessage client for managing background downloads
 - **Parallel chunk downloads** — large files (100MB+) split into configurable chunks, downloaded concurrently
 - **Header+trailer first** — MP4 moov atom fetched first for instant playback start before full download
 - **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
+- **CacheAnalyzer** — stale media detection and storage-pressure eviction
 - **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
 
+No Cache API is used anywhere. All content is stored on the filesystem via the proxy's ContentStore.
+
 ## Installation
 
 ```bash
@@ -23,24 +27,29 @@ npm install @xiboplayer/cache
 ## Usage
 
 ```javascript
-import { CacheProxy } from '@xiboplayer/cache';
-
-const cache = new CacheProxy();
-await cache.init();
-
-// Request downloads (delegated to Service Worker)
-await cache.requestDownload({ layoutOrder, files });
-
-// Check if a file is cached
-const isCached = await cache.has(fileId);
+import { StoreClient, DownloadClient } from '@xiboplayer/cache';
+
+// Storage operations (pure REST, no SW needed)
+const store = new StoreClient();
+const { exists, size } = await store.has('media', '123');
+const blob = await store.get('media', '123');
+await store.put('widget', '472/221/190', htmlBlob, 'text/html');
+
+// Download management (SW postMessage)
+const downloads = new DownloadClient();
+await downloads.init();
+await downloads.download(files);
+const progress = await downloads.getProgress();
 ```
 
 ## Exports
 
 | Export | Description |
 |--------|-------------|
-| `CacheProxy` | Browser-side proxy communicating with SW backend |
+| `StoreClient` | Pure REST client for ContentStore — has/get/put/remove/list |
+| `DownloadClient` | SW postMessage client for background downloads |
 | `DownloadManager` | Core download queue with barrier-based ordering |
+| `CacheAnalyzer` | Stale media detection and eviction |
 
 ## Dependencies