@xiboplayer/xmds 0.4.0 → 0.4.1

package/README.md

@@ -43,9 +43,9 @@ const schedule = await client.schedule();
 | `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 |
+| `submitStats(stats, hardwareKeyOverride?)` | Submit proof of play statistics (optional `hardwareKeyOverride` for delegated submissions on behalf of another display) |
 | `submitScreenShot(base64)` | Upload a screenshot to the CMS |
-| `submitLog(logs)` | Submit display logs |
+| `submitLog(logs, hardwareKeyOverride?)` | Submit display logs (optional `hardwareKeyOverride` for delegated submissions on behalf of another display) |
 
 ## Dependencies
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xiboplayer/xmds",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "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.4.0"
+    "@xiboplayer/utils": "0.4.1"
   },
   "devDependencies": {
     "vitest": "^2.0.0"

package/src/rest-client.js

@@ -35,6 +35,32 @@ export class RestClient {
     return base.replace(/\/+$/, '');
   }
 
+  /**
+   * Check if running behind the local proxy (Electron or Chromium kiosk).
+   */
+  _isProxyMode() {
+    return typeof window !== 'undefined' &&
+      (window.electronAPI?.isElectron ||
+       (window.location.hostname === 'localhost' && window.location.port === '8765'));
+  }
+
+  /**
+   * Rewrite an absolute REST URL to go through /rest-proxy.
+   * Preserves all query params from the original URL.
+   */
+  _rewriteForProxy(urlString) {
+    if (!this._isProxyMode() || !urlString.startsWith('http')) return urlString;
+    const parsed = new URL(urlString);
+    const proxyUrl = new URL('/rest-proxy', window.location.origin);
+    proxyUrl.searchParams.set('cms', parsed.origin);
+    proxyUrl.searchParams.set('path', parsed.pathname);
+    // Forward all original query params
+    for (const [key, value] of parsed.searchParams) {
+      proxyUrl.searchParams.set(key, value);
+    }
+    return proxyUrl.toString();
+  }
+
   /**
    * Make a REST GET request with optional ETag caching.
    * Returns the parsed JSON body, or cached data on 304.
@@ -57,7 +83,7 @@ export class RestClient {
 
     log.debug(`GET ${path}`, queryParams);
 
-    const response = await fetchWithRetry(url.toString(), {
+    const response = await fetchWithRetry(this._rewriteForProxy(url.toString()), {
       method: 'GET',
       headers,
     }, this.retryOptions);
@@ -107,7 +133,7 @@ export class RestClient {
 
     log.debug(`${method} ${path}`);
 
-    const response = await fetchWithRetry(url.toString(), {
+    const response = await fetchWithRetry(this._rewriteForProxy(url.toString()), {
       method,
       headers: { 'Content-Type': 'application/json' },
       body: JSON.stringify({
@@ -185,9 +211,20 @@ export class RestClient {
         continue;
       }
       if (key === 'tags') {
-        // Parse tags: array of strings, or array of {tag: "value"} objects
+        // Parse tags from CMS JSON (SimpleXMLElement serialization varies):
+        //   Array of strings: ["geoApiKey|AIzaSy..."]
+        //   Array of objects: [{tag: "geoApiKey|AIzaSy..."}]
+        //   Single-tag object: {tag: "geoApiKey|AIzaSy..."} (SimpleXMLElement collapses single-element arrays)
+        //   String: "geoApiKey|AIzaSy..."
+        const extractTag = (t) => typeof t === 'object' ? (t.tag || t.value || '') : String(t);
         if (Array.isArray(value)) {
-          tags = value.map(t => typeof t === 'object' ? (t.tag || t.value || '') : String(t)).filter(Boolean);
+          tags = value.map(extractTag).filter(Boolean);
+        } else if (value && typeof value === 'object') {
+          // Single tag: {tag: "value"} — wrap in array
+          const t = extractTag(value);
+          if (t) tags = [t];
+        } else if (typeof value === 'string' && value) {
+          tags = [value];
         }
         continue;
       }
@@ -364,9 +401,10 @@ export class RestClient {
    * SubmitLog - submit player logs to CMS
    * POST /log → JSON acknowledgement
    */
-  async submitLog(logXml) {
+  async submitLog(logXml, hardwareKeyOverride = null) {
     // Accept array (JSON-native) or string (XML) — send under the right key
     const body = Array.isArray(logXml) ? { logs: logXml } : { logXml };
+    if (hardwareKeyOverride) body.hardwareKey = hardwareKeyOverride;
     const result = await this.restSend('POST', '/log', body);
     return result?.success === true;
   }
@@ -406,10 +444,11 @@ export class RestClient {
     return this.restGet('/weather');
   }
 
-  async submitStats(statsXml) {
+  async submitStats(statsXml, hardwareKeyOverride = null) {
     try {
       // Accept array (JSON-native) or string (XML) — send under the right key
       const body = Array.isArray(statsXml) ? { stats: statsXml } : { statXml: statsXml };
+      if (hardwareKeyOverride) body.hardwareKey = hardwareKeyOverride;
       const result = await this.restSend('POST', '/stats', body);
       const success = result?.success === true;
       log.info(`SubmitStats result: ${success}`);

package/src/xmds-client.js

@@ -382,10 +382,10 @@ export class XmdsClient {
    * @param {string} logXml - XML string containing log entries
    * @returns {Promise<boolean>} - true if logs were successfully submitted
    */
-  async submitLog(logXml) {
+  async submitLog(logXml, hardwareKeyOverride = null) {
     const xml = await this.call('SubmitLog', {
       serverKey: this.config.cmsKey,
-      hardwareKey: this.config.hardwareKey,
+      hardwareKey: hardwareKeyOverride || this.config.hardwareKey,
       logXml: logXml
     });
 
@@ -436,11 +436,11 @@ export class XmdsClient {
     });
   }
 
-  async submitStats(statsXml) {
+  async submitStats(statsXml, hardwareKeyOverride = null) {
     try {
       const xml = await this.call('SubmitStats', {
         serverKey: this.config.cmsKey,
-        hardwareKey: this.config.hardwareKey,
+        hardwareKey: hardwareKeyOverride || this.config.hardwareKey,
         statXml: statsXml
       });