@xiboplayer/utils 0.6.1 → 0.6.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xiboplayer/utils",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "description": "Shared utilities for Xibo Player packages",
   "type": "module",
   "main": "./src/index.js",
@@ -12,7 +12,7 @@
     "./config": "./src/config.js"
   },
   "dependencies": {
-    "@xiboplayer/crypto": "0.6.1"
+    "@xiboplayer/crypto": "0.6.3"
   },
   "devDependencies": {
     "vitest": "^2.0.0"

package/src/cms-api.js

@@ -111,15 +111,7 @@ export class CmsApiClient {
     const response = await fetch(url, options);
 
     if (!response.ok) {
-      const text = await response.text();
-      let errorMsg;
-      try {
-        const errorData = JSON.parse(text);
-        errorMsg = errorData.error?.message || errorData.message || text;
-      } catch (_) {
-        errorMsg = text;
-      }
-      throw new CmsApiError(method, path, response.status, errorMsg);
+      await this._handleErrorResponse(response, method, path);
     }
 
     // Some endpoints return empty body (204)
@@ -141,6 +133,35 @@ export class CmsApiClient {
   /** DELETE request (path relative to /api/) */
   del(path) { return this.request('DELETE', path); }
 
+  /**
+   * GET a list endpoint and ensure the result is always an array.
+   * @param {string} path - API path
+   * @param {Object} [filters={}] - Query parameters
+   * @returns {Promise<Array>}
+   */
+  async _listRequest(path, filters = {}) {
+    const data = await this.request('GET', path, filters);
+    return Array.isArray(data) ? data : [];
+  }
+
+  /**
+   * Parse an error response body and throw a structured error.
+   * @param {Response} response - Fetch response
+   * @param {string} method - HTTP method
+   * @param {string} path - API path
+   */
+  async _handleErrorResponse(response, method, path) {
+    const text = await response.text();
+    let errorMsg;
+    try {
+      const errorData = JSON.parse(text);
+      errorMsg = errorData.error?.message || errorData.message || text;
+    } catch (_) {
+      errorMsg = text;
+    }
+    throw new CmsApiError(method, path, response.status, errorMsg);
+  }
+
   // ── Display Management ──────────────────────────────────────────
 
   /**
@@ -150,10 +171,7 @@ export class CmsApiClient {
    */
   async findDisplay(hardwareKey) {
     log.info('Looking up display by hardwareKey:', hardwareKey);
-    const data = await this.request('GET', '/display', { hardwareKey });
-
-    // API returns array of matching displays
-    const displays = Array.isArray(data) ? data : [];
+    const displays = await this._listRequest('/display', { hardwareKey });
     if (displays.length === 0) {
       log.info('No display found for hardwareKey:', hardwareKey);
       return null;
@@ -192,8 +210,7 @@ export class CmsApiClient {
    * @returns {Promise<Array>} Array of display objects
    */
   async listDisplays(filters = {}) {
-    const data = await this.request('GET', '/display', filters);
-    return Array.isArray(data) ? data : [];
+    return this._listRequest('/display', filters);
   }
 
   /**
@@ -238,15 +255,7 @@ export class CmsApiClient {
     });
 
     if (!response.ok) {
-      const text = await response.text();
-      let errorMsg;
-      try {
-        const errorData = JSON.parse(text);
-        errorMsg = errorData.error?.message || errorData.message || text;
-      } catch (_) {
-        errorMsg = text;
-      }
-      throw new Error(`CMS API ${method} ${path} failed (${response.status}): ${errorMsg}`);
+      await this._handleErrorResponse(response, method, path);
     }
 
     const contentType = response.headers.get('Content-Type') || '';
@@ -278,8 +287,7 @@ export class CmsApiClient {
    * @returns {Promise<Array>}
    */
   async listLayouts(filters = {}) {
-    const data = await this.request('GET', '/layout', filters);
-    return Array.isArray(data) ? data : [];
+    return this._listRequest('/layout', filters);
   }
 
   /**
@@ -446,8 +454,7 @@ export class CmsApiClient {
    * @returns {Promise<Array>}
    */
   async listMedia(filters = {}) {
-    const data = await this.request('GET', '/library', filters);
-    return Array.isArray(data) ? data : [];
+    return this._listRequest('/library', filters);
   }
 
   /**
@@ -485,8 +492,7 @@ export class CmsApiClient {
    * @returns {Promise<Array>}
    */
   async listCampaigns(filters = {}) {
-    const data = await this.request('GET', '/campaign', filters);
-    return Array.isArray(data) ? data : [];
+    return this._listRequest('/campaign', filters);
   }
 
   /**
@@ -600,8 +606,7 @@ export class CmsApiClient {
    * @returns {Promise<Array>}
    */
   async listDisplayGroups(filters = {}) {
-    const data = await this.request('GET', '/displaygroup', filters);
-    return Array.isArray(data) ? data : [];
+    return this._listRequest('/displaygroup', filters);
   }
 
   /**
@@ -688,8 +693,7 @@ export class CmsApiClient {
    * @returns {Promise<Array>}
    */
   async listResolutions() {
-    const data = await this.request('GET', '/resolution');
-    return Array.isArray(data) ? data : [];
+    return this._listRequest('/resolution');
   }
 
   // ── Template Management ──────────────────────────────────────────
@@ -700,8 +704,7 @@ export class CmsApiClient {
    * @returns {Promise<Array>}
    */
   async listTemplates(filters = {}) {
-    const data = await this.request('GET', '/template', filters);
-    return Array.isArray(data) ? data : [];
+    return this._listRequest('/template', filters);
   }
 
   // ── Playlist Management ──────────────────────────────────────────
@@ -870,8 +873,7 @@ export class CmsApiClient {
    * @returns {Promise<Array>}
    */
   async listCommands(filters = {}) {
-    const data = await this.get('/command', filters);
-    return Array.isArray(data) ? data : [];
+    return this._listRequest('/command', filters);
   }
 
   /**
@@ -949,8 +951,7 @@ export class CmsApiClient {
    * @returns {Promise<Array>}
    */
   async listDayParts(filters = {}) {
-    const data = await this.get('/daypart', filters);
-    return Array.isArray(data) ? data : [];
+    return this._listRequest('/daypart', filters);
   }
 
   /**
@@ -1055,8 +1056,7 @@ export class CmsApiClient {
    * @returns {Promise<Array>}
    */
   async listPlaylists(filters = {}) {
-    const data = await this.get('/playlist', filters);
-    return Array.isArray(data) ? data : [];
+    return this._listRequest('/playlist', filters);
   }
 
   /**
@@ -1212,8 +1212,7 @@ export class CmsApiClient {
    * @returns {Promise<Array>}
    */
   async listDatasets(filters = {}) {
-    const data = await this.get('/dataset', filters);
-    return Array.isArray(data) ? data : [];
+    return this._listRequest('/dataset', filters);
   }
 
   /**
@@ -1250,8 +1249,7 @@ export class CmsApiClient {
    * @returns {Promise<Array>}
    */
   async listDatasetColumns(dataSetId) {
-    const data = await this.get(`/dataset/${dataSetId}/column`);
-    return Array.isArray(data) ? data : [];
+    return this._listRequest(`/dataset/${dataSetId}/column`);
   }
 
   /**
@@ -1292,8 +1290,7 @@ export class CmsApiClient {
    * @returns {Promise<Array>}
    */
   async listDatasetData(dataSetId, filters = {}) {
-    const data = await this.get(`/dataset/data/${dataSetId}`, filters);
-    return Array.isArray(data) ? data : [];
+    return this._listRequest(`/dataset/data/${dataSetId}`, filters);
   }
 
   /**
@@ -1354,8 +1351,7 @@ export class CmsApiClient {
    * @returns {Promise<Array>}
    */
   async listNotifications(filters = {}) {
-    const data = await this.get('/notification', filters);
-    return Array.isArray(data) ? data : [];
+    return this._listRequest('/notification', filters);
   }
 
   /**
@@ -1394,8 +1390,7 @@ export class CmsApiClient {
    * @returns {Promise<Array>}
    */
   async listFolders(filters = {}) {
-    const data = await this.get('/folder', filters);
-    return Array.isArray(data) ? data : [];
+    return this._listRequest('/folder', filters);
   }
 
   /**
@@ -1434,8 +1429,7 @@ export class CmsApiClient {
    * @returns {Promise<Array>}
    */
   async listTags(filters = {}) {
-    const data = await this.get('/tag', filters);
-    return Array.isArray(data) ? data : [];
+    return this._listRequest('/tag', filters);
   }
 
   /**

package/src/logger.js

@@ -40,6 +40,12 @@ class Logger {
     }
   }
 
+  /** HH:MM:SS.mmm timestamp for log lines */
+  _ts() {
+    const d = new Date();
+    return `${String(d.getHours()).padStart(2, '0')}:${String(d.getMinutes()).padStart(2, '0')}:${String(d.getSeconds()).padStart(2, '0')}.${String(d.getMilliseconds()).padStart(3, '0')}`;
+  }
+
   setLevel(level) {
     this.useGlobal = false;
     if (typeof level === 'string') {
@@ -56,28 +62,28 @@ class Logger {
 
   debug(...args) {
     if (this.getEffectiveLevel() <= LOG_LEVELS.DEBUG) {
-      console.log(`[${this.name}] DEBUG:`, ...args);
+      console.log(`${this._ts()} [${this.name}] DEBUG:`, ...args);
     }
     _dispatchToSinks('debug', this.name, args);
   }
 
   info(...args) {
     if (this.getEffectiveLevel() <= LOG_LEVELS.INFO) {
-      console.log(`[${this.name}]`, ...args);
+      console.log(`${this._ts()} [${this.name}]`, ...args);
     }
     _dispatchToSinks('info', this.name, args);
   }
 
   warn(...args) {
     if (this.getEffectiveLevel() <= LOG_LEVELS.WARNING) {
-      console.warn(`[${this.name}]`, ...args);
+      console.warn(`${this._ts()} [${this.name}]`, ...args);
     }
     _dispatchToSinks('warning', this.name, args);
   }
 
   error(...args) {
     if (this.getEffectiveLevel() <= LOG_LEVELS.ERROR) {
-      console.error(`[${this.name}]`, ...args);
+      console.error(`${this._ts()} [${this.name}]`, ...args);
     }
     _dispatchToSinks('error', this.name, args);
   }

package/src/logger.test.js

@@ -7,6 +7,10 @@
 import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
 import { createLogger, setLogLevel, getLogLevel, LOG_LEVELS } from './logger.js';
 
+// Matches "HH:MM:SS.mmm [Name]" or "HH:MM:SS.mmm [Name] DEBUG:"
+const ts = (name, suffix = '') =>
+  expect.stringMatching(new RegExp(`^\\d{2}:\\d{2}:\\d{2}\\.\\d{3} \\[${name}\\]${suffix}$`));
+
 describe('Logger', () => {
   let consoleLogSpy;
   let consoleWarnSpy;
@@ -62,7 +66,7 @@ describe('Logger', () => {
       logger.debug('Debug message', { data: 'value' });
 
       expect(consoleLogSpy).toHaveBeenCalledWith(
-        '[Test] DEBUG:',
+        ts('Test', ' DEBUG:'),
         'Debug message',
         { data: 'value' }
       );
@@ -100,7 +104,7 @@ describe('Logger', () => {
       logger.info('Info message', 'arg1', 'arg2');
 
       expect(consoleLogSpy).toHaveBeenCalledWith(
-        '[Test]',
+        ts('Test'),
         'Info message',
         'arg1',
         'arg2'
@@ -139,7 +143,7 @@ describe('Logger', () => {
       logger.warn('Warning message', { warn: true });
 
       expect(consoleWarnSpy).toHaveBeenCalledWith(
-        '[Test]',
+        ts('Test'),
         'Warning message',
         { warn: true }
       );
@@ -177,7 +181,7 @@ describe('Logger', () => {
       logger.error('Error message', new Error('Test error'));
 
       expect(consoleErrorSpy).toHaveBeenCalledWith(
-        '[Test]',
+        ts('Test'),
         'Error message',
         expect.any(Error)
       );
@@ -226,37 +230,37 @@ describe('Logger', () => {
     it('should delegate to debug()', () => {
       logger.log('DEBUG', 'message');
 
-      expect(consoleLogSpy).toHaveBeenCalledWith('[Test] DEBUG:', 'message');
+      expect(consoleLogSpy).toHaveBeenCalledWith(ts('Test', ' DEBUG:'), 'message');
     });
 
     it('should delegate to info()', () => {
       logger.log('INFO', 'message');
 
-      expect(consoleLogSpy).toHaveBeenCalledWith('[Test]', 'message');
+      expect(consoleLogSpy).toHaveBeenCalledWith(ts('Test'), 'message');
     });
 
     it('should delegate to warn() for WARNING', () => {
       logger.log('WARNING', 'message');
 
-      expect(consoleWarnSpy).toHaveBeenCalledWith('[Test]', 'message');
+      expect(consoleWarnSpy).toHaveBeenCalledWith(ts('Test'), 'message');
     });
 
     it('should delegate to warn() for WARN', () => {
       logger.log('WARN', 'message');
 
-      expect(consoleWarnSpy).toHaveBeenCalledWith('[Test]', 'message');
+      expect(consoleWarnSpy).toHaveBeenCalledWith(ts('Test'), 'message');
     });
 
     it('should delegate to error()', () => {
       logger.log('ERROR', 'message');
 
-      expect(consoleErrorSpy).toHaveBeenCalledWith('[Test]', 'message');
+      expect(consoleErrorSpy).toHaveBeenCalledWith(ts('Test'), 'message');
     });
 
     it('should handle lowercase level names', () => {
       logger.log('debug', 'message');
 
-      expect(consoleLogSpy).toHaveBeenCalledWith('[Test] DEBUG:', 'message');
+      expect(consoleLogSpy).toHaveBeenCalledWith(ts('Test', ' DEBUG:'), 'message');
     });
   });
 
@@ -345,7 +349,7 @@ describe('Logger', () => {
       logger.info('Message', 1, 'two', { three: 3 }, [4, 5]);
 
       expect(consoleLogSpy).toHaveBeenCalledWith(
-        '[Test]',
+        ts('Test'),
         'Message',
         1,
         'two',
@@ -357,7 +361,7 @@ describe('Logger', () => {
     it('should handle zero arguments', () => {
       logger.info();
 
-      expect(consoleLogSpy).toHaveBeenCalledWith('[Test]');
+      expect(consoleLogSpy).toHaveBeenCalledWith(ts('Test'));
     });
 
     it('should handle objects and errors', () => {
@@ -367,7 +371,7 @@ describe('Logger', () => {
       logger.error('Error:', error, obj);
 
       expect(consoleErrorSpy).toHaveBeenCalledWith(
-        '[Test]',
+        ts('Test'),
         'Error:',
         error,
         obj
@@ -381,7 +385,7 @@ describe('Logger', () => {
 
       logger.info('Test');
 
-      expect(consoleLogSpy).toHaveBeenCalledWith('[MyModule]', 'Test');
+      expect(consoleLogSpy).toHaveBeenCalledWith(ts('MyModule'), 'Test');
     });
 
     it('should support different module names', () => {
@@ -391,8 +395,8 @@ describe('Logger', () => {
       logger1.info('From 1');
       logger2.info('From 2');
 
-      expect(consoleLogSpy).toHaveBeenCalledWith('[Module1]', 'From 1');
-      expect(consoleLogSpy).toHaveBeenCalledWith('[Module2]', 'From 2');
+      expect(consoleLogSpy).toHaveBeenCalledWith(ts('Module1'), 'From 1');
+      expect(consoleLogSpy).toHaveBeenCalledWith(ts('Module2'), 'From 2');
     });
   });
 
@@ -402,7 +406,7 @@ describe('Logger', () => {
 
       logger.info('Test');
 
-      expect(consoleLogSpy).toHaveBeenCalledWith('[null]', 'Test');
+      expect(consoleLogSpy).toHaveBeenCalledWith(ts('null'), 'Test');
     });
 
     it('should handle undefined level (use default)', () => {
@@ -419,7 +423,7 @@ describe('Logger', () => {
 
       logger.info(longMessage);
 
-      expect(consoleLogSpy).toHaveBeenCalledWith('[Test]', longMessage);
+      expect(consoleLogSpy).toHaveBeenCalledWith(ts('Test'), longMessage);
     });
 
     it('should handle circular references in objects', () => {