@xiboplayer/xmds 0.7.21 → 0.7.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xiboplayer/xmds",
-  "version": "0.7.21",
+  "version": "0.7.22",
   "description": "XMDS SOAP client for Xibo CMS communication",
   "type": "module",
   "main": "./src/index.js",
@@ -12,7 +12,7 @@
     "./schedule-parser": "./src/schedule-parser.js"
   },
   "dependencies": {
-    "@xiboplayer/utils": "0.7.21"
+    "@xiboplayer/utils": "0.7.22"
   },
   "devDependencies": {
     "vitest": "^4.1.2"

package/src/schedule-parser.js

@@ -30,6 +30,35 @@ function parseCriteria(parentEl) {
   return criteria;
 }
 
+/**
+ * Parse a `<tags>` child element (if present) into a flat string array.
+ *
+ * Used by the #236 sync bridge when a schedule response exposes
+ * per-layout tags (e.g. `<tag>xp-sync-group:NAME</tag>`). Upstream
+ * Xibo CMS does NOT currently emit `<tags>` inside schedule `<layout>`
+ * entries — the authoritative source is the XLF file itself, parsed
+ * by renderer-lite.parseXlf(). This helper exists so that:
+ *   1. A forked CMS that DOES emit per-layout `<tags>` (or future
+ *      upstream) gets them surfaced for free.
+ *   2. Callers can treat `layout.tags` as a stable field (empty array
+ *      when absent).
+ *
+ * @param {Element} parentEl - Layout/campaign-layout element
+ * @returns {string[]} Tags parsed from a direct <tags> child, or [].
+ */
+function parseLayoutTags(parentEl) {
+  const tags = [];
+  for (const child of parentEl.children) {
+    if (child.tagName !== 'tags') continue;
+    for (const tagEl of child.children) {
+      if (tagEl.tagName !== 'tag') continue;
+      const text = (tagEl.textContent || '').trim();
+      if (text) tags.push(text);
+    }
+  }
+  return tags;
+}
+
 /**
  * Parse Schedule XML response into a normalized schedule object.
  *
@@ -121,7 +150,8 @@ export function parseScheduleResponse(xml) {
         groupKey: layoutEl.getAttribute('groupKey') || null,
         playCount: parseInt(layoutEl.getAttribute('playCount') || '0'),
         dependants: depEls.length > 0 ? [...depEls].map(el => el.textContent) : [],
-        criteria: parseCriteria(layoutEl)
+        criteria: parseCriteria(layoutEl),
+        tags: parseLayoutTags(layoutEl) // #236 sync bridge (currently no-op upstream; forks may emit)
       });
     }
 
@@ -154,7 +184,8 @@ export function parseScheduleResponse(xml) {
       recurrenceRepeatsOn: layoutEl.getAttribute('recurrenceRepeatsOn') || null,
       recurrenceRange: layoutEl.getAttribute('recurrenceRange') || null,
       dependants: depEls.length > 0 ? [...depEls].map(el => el.textContent) : [],
-      criteria: parseCriteria(layoutEl)
+      criteria: parseCriteria(layoutEl),
+      tags: parseLayoutTags(layoutEl) // #236 sync bridge (currently no-op upstream; forks may emit)
     });
   }
 

package/src/schedule-parser.test.js

@@ -264,6 +264,82 @@ describe('parseScheduleResponse', () => {
     expect(layout.playCount).toBe(2);
   });
 
+  // ── Layout tag surfacing (#236 sync bridge) ───────────────────
+  //
+  // Upstream Xibo CMS does NOT currently emit <tags> as a child of
+  // <layout> in Schedule XMDS responses (only <dependants>,
+  // <criteria>). The authoritative source for layout tags is the XLF
+  // file itself, parsed by renderer-lite. These tests exercise the
+  // defensive path for forks / future upstream that DO emit <tags>,
+  // and document that the default is an empty array.
+
+  describe('layout tag surfacing (#236)', () => {
+    it('defaults tags to empty array on standalone layouts', () => {
+      const xml = `<schedule>
+        <layout file="100.xlf" fromdt="2025-01-01 00:00:00" todt="2025-12-31 23:59:59"
+                scheduleid="1" priority="0"/>
+      </schedule>`;
+      const result = parseScheduleResponse(xml);
+      expect(result.layouts[0].tags).toEqual([]);
+    });
+
+    it('defaults tags to empty array on campaign layouts', () => {
+      const xml = `<schedule>
+        <campaign id="c1" priority="5" fromdt="2025-01-01 00:00:00" todt="2025-12-31 23:59:59"
+                  scheduleid="30">
+          <layout file="500.xlf"/>
+        </campaign>
+      </schedule>`;
+      const result = parseScheduleResponse(xml);
+      expect(result.campaigns[0].layouts[0].tags).toEqual([]);
+    });
+
+    it('parses <tags> when present on standalone layouts', () => {
+      const xml = `<schedule>
+        <layout file="700.xlf" fromdt="2025-01-01 00:00:00" todt="2025-12-31 23:59:59"
+                scheduleid="7" priority="0">
+          <tags>
+            <tag>xp-sync-group:lobby-wall</tag>
+            <tag>smil-imported</tag>
+          </tags>
+        </layout>
+      </schedule>`;
+      const result = parseScheduleResponse(xml);
+      expect(result.layouts[0].tags).toEqual([
+        'xp-sync-group:lobby-wall',
+        'smil-imported',
+      ]);
+    });
+
+    it('parses <tags> when present on campaign layouts', () => {
+      const xml = `<schedule>
+        <campaign id="c1" priority="5" fromdt="2025-01-01 00:00:00" todt="2025-12-31 23:59:59"
+                  scheduleid="30">
+          <layout file="500.xlf">
+            <tags><tag>xp-sync-group:atrium</tag></tags>
+          </layout>
+        </campaign>
+      </schedule>`;
+      const result = parseScheduleResponse(xml);
+      expect(result.campaigns[0].layouts[0].tags).toEqual(['xp-sync-group:atrium']);
+    });
+
+    it('skips empty and whitespace-only <tag> elements', () => {
+      const xml = `<schedule>
+        <layout file="800.xlf" fromdt="2025-01-01 00:00:00" todt="2025-12-31 23:59:59"
+                scheduleid="8" priority="0">
+          <tags>
+            <tag>  xp-sync-group:lobby  </tag>
+            <tag></tag>
+            <tag>   </tag>
+          </tags>
+        </layout>
+      </schedule>`;
+      const result = parseScheduleResponse(xml);
+      expect(result.layouts[0].tags).toEqual(['xp-sync-group:lobby']);
+    });
+  });
+
   it('should use consistent lowercase casing for fromdt/todt/scheduleid on overlays', () => {
     const xml = `<schedule>
       <overlays>