@xiboplayer/xmds 0.1.3 → 0.3.0

package/README.md

@@ -0,0 +1,56 @@
+# @xiboplayer/xmds
+
+**XMDS SOAP + REST client for Xibo CMS communication.**
+
+## Overview
+
+Dual-transport client supporting both Xibo communication protocols:
+
+- **XMDS SOAP** (v3-v7) — standard Xibo player protocol with XML encoding
+- **REST API** — lighter JSON transport (~30% smaller payloads) with ETag caching
+
+Both transports expose the same API. The REST client is preferred when available.
+
+## Installation
+
+```bash
+npm install @xiboplayer/xmds
+```
+
+## Usage
+
+```javascript
+import { RestClient } from '@xiboplayer/xmds';
+
+const client = new RestClient({
+  cmsUrl: 'https://your-cms.example.com',
+  serverKey: 'your-key',
+  hardwareKey: 'display-id',
+});
+
+const result = await client.registerDisplay();
+const files = await client.requiredFiles();
+const schedule = await client.schedule();
+```
+
+## Methods
+
+| Method | Description |
+|--------|-------------|
+| `registerDisplay()` | Register/authorize the display with the CMS |
+| `requiredFiles()` | Get list of required media files and layouts |
+| `schedule()` | Get the current schedule XML |
+| `getResource(regionId, mediaId)` | Get rendered widget HTML |
+| `notifyStatus(status)` | Report display status to CMS |
+| `mediaInventory(inventory)` | Report cached media inventory |
+| `submitStats(stats)` | Submit proof of play statistics |
+| `submitScreenShot(base64)` | Upload a screenshot to the CMS |
+| `submitLog(logs)` | Submit display logs |
+
+## Dependencies
+
+- `@xiboplayer/utils` — logger, events, fetchWithRetry
+
+---
+
+**Part of the [XiboPlayer SDK](https://github.com/linuxnow/xiboplayer)**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xiboplayer/xmds",
-  "version": "0.1.3",
+  "version": "0.3.0",
   "description": "XMDS SOAP client for Xibo CMS communication",
   "type": "module",
   "main": "./src/index.js",
@@ -9,7 +9,7 @@
     "./xmds": "./src/xmds.js"
   },
   "dependencies": {
-    "@xiboplayer/utils": "0.1.3"
+    "@xiboplayer/utils": "0.3.0"
   },
   "devDependencies": {
     "vitest": "^2.0.0"

package/src/index.js

@@ -1,4 +1,6 @@
 // @xiboplayer/xmds - XMDS clients (REST and SOAP)
+import pkg from '../package.json' with { type: 'json' };
+export const VERSION = pkg.version;
 export { RestClient } from './rest-client.js';
 export { XmdsClient } from './xmds-client.js';
 export { parseScheduleResponse } from './schedule-parser.js';

package/docs/README.md

@@ -1,60 +0,0 @@
-# @xiboplayer/xmds Documentation
-
-**XMDS (XML-based Media Distribution Service) SOAP client.**
-
-## Overview
-
-SOAP client for Xibo CMS communication:
-
-- Display registration
-- Content synchronization
-- File downloads
-- Proof of play submission
-- Log reporting
-
-## Installation
-
-```bash
-npm install @xiboplayer/xmds
-```
-
-## Usage
-
-```javascript
-import { XMDSClient } from '@xiboplayer/xmds';
-
-const client = new XMDSClient({
-  cmsUrl: 'https://cms.example.com',
-  serverKey: 'abc123',
-  hardwareKey: 'def456'
-});
-
-// Register display
-await client.registerDisplay();
-
-// Get required files
-const files = await client.requiredFiles();
-
-// Download file
-const blob = await client.getFile(fileId, fileType);
-```
-
-## SOAP Methods
-
-- `RegisterDisplay` - Register/verify display
-- `RequiredFiles` - Get content to download
-- `GetFile` - Download media file
-- `SubmitStats` - Send proof of play
-- `SubmitLog` - Report errors
-
-## Dependencies
-
-- `@xiboplayer/utils` - Logger
-
-## Related Packages
-
-- [@xiboplayer/core](../../core/docs/) - Player core
-
----
-
-**Package Version**: 1.0.0