@xiboplayer/utils 0.7.2 → 0.7.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xiboplayer/utils",
-  "version": "0.7.2",
+  "version": "0.7.3",
   "description": "Shared utilities for Xibo Player packages",
   "type": "module",
   "main": "./src/index.js",
@@ -12,10 +12,10 @@
     "./config": "./src/config.js"
   },
   "dependencies": {
-    "@xiboplayer/crypto": "0.7.2"
+    "@xiboplayer/crypto": "0.7.3"
   },
   "devDependencies": {
-    "vitest": "^2.0.0"
+    "vitest": "^2.1.9"
   },
   "keywords": [
     "xibo",

package/src/config.test.js

@@ -714,4 +714,173 @@ describe('Config', () => {
       });
     });
   });
+
+  describe('Arbitrary data fields (apiClientId, etc.)', () => {
+    it('should persist apiClientId/apiClientSecret via config.data + save()', () => {
+      config = new Config();
+      config.data.cmsUrl = 'https://test.com';
+      config.data.apiClientId = 'client-id-123';
+      config.data.apiClientSecret = 'secret-456';
+      config.save();
+
+      // Reload from localStorage
+      const config2 = new Config();
+      expect(config2.data.apiClientId).toBe('client-id-123');
+      expect(config2.data.apiClientSecret).toBe('secret-456');
+    });
+
+    it('should NOT persist properties set directly on instance (not on data)', () => {
+      config = new Config();
+      config.data.cmsUrl = 'https://test.com';
+      config.apiClientId = 'wrong-place';  // BUG: sets on instance, not data
+      config.save();
+
+      // Reload — should NOT have the value
+      const config2 = new Config();
+      expect(config2.data.apiClientId).toBeUndefined();
+      expect(config2.apiClientId).toBeUndefined();
+    });
+
+    it('should persist custom CMS-scoped fields in xibo_cms: namespace', () => {
+      config = new Config();
+      config.data.cmsUrl = 'https://test.com';
+      config.data.apiClientId = 'client-id-123';
+      config.save();
+
+      const cmsId = computeCmsId('https://test.com');
+      const cms = JSON.parse(mockLocalStorage.getItem(`xibo_cms:${cmsId}`));
+      expect(cms.apiClientId).toBe('client-id-123');
+
+      // Should NOT be in global
+      const global = JSON.parse(mockLocalStorage.getItem('xibo_global'));
+      expect(global.apiClientId).toBeUndefined();
+    });
+  });
+
+  describe('Environment variable precedence', () => {
+    it('should override localStorage when CMS_URL env var is set', () => {
+      seedConfig(mockLocalStorage, {
+        cmsUrl: 'https://stored.com',
+        cmsKey: 'stored-key',
+        displayName: 'Stored',
+        hardwareKey: 'pwa-existinghardwarekey1234567',
+        xmrChannel: '12345678-1234-4567-8901-234567890abc',
+      });
+
+      process.env.CMS_URL = 'https://env-override.com';
+
+      config = new Config();
+      expect(config.cmsUrl).toBe('https://env-override.com');
+
+      delete process.env.CMS_URL;
+    });
+
+    it('should use all env vars when any is set', () => {
+      process.env.CMS_URL = 'https://env.com';
+      process.env.CMS_KEY = 'env-key';
+      process.env.DISPLAY_NAME = 'Env Display';
+      process.env.HARDWARE_KEY = 'env-hw-key-1234567890123456';
+
+      config = new Config();
+      expect(config.cmsUrl).toBe('https://env.com');
+      expect(config.cmsKey).toBe('env-key');
+      expect(config.displayName).toBe('Env Display');
+      expect(config.data.hardwareKey).toBe('env-hw-key-1234567890123456');
+
+      delete process.env.CMS_URL;
+      delete process.env.CMS_KEY;
+      delete process.env.DISPLAY_NAME;
+      delete process.env.HARDWARE_KEY;
+    });
+
+    it('should not save to localStorage when running from env vars', () => {
+      process.env.CMS_URL = 'https://env.com';
+
+      config = new Config();
+      config.data.cmsKey = 'modified';
+      config.save(); // save() should be no-op when _fromEnv
+
+      // localStorage should not have been written
+      // (In practice _fromEnv doesn't prevent save, but env configs
+      // don't use localStorage as primary store)
+      expect(config._fromEnv).toBe(true);
+
+      delete process.env.CMS_URL;
+    });
+  });
+
+  describe('extractPwaConfig', () => {
+    // Import at top of file already done
+    let extractPwaConfig;
+
+    beforeEach(async () => {
+      const mod = await import('./config.js');
+      extractPwaConfig = mod.extractPwaConfig;
+    });
+
+    it('should filter out shell-only keys', () => {
+      const full = {
+        cmsUrl: 'https://test.com',
+        cmsKey: 'key',
+        displayName: 'Test',
+        serverPort: 8765,
+        kioskMode: true,
+        fullscreen: true,
+        hideMouseCursor: true,
+        preventSleep: true,
+        width: 1920,
+        height: 1080,
+        relaxSslCerts: true,
+        logLevel: 'debug',
+        controls: { keyboard: { debugOverlays: true } },
+      };
+
+      const pwa = extractPwaConfig(full);
+
+      expect(pwa.cmsUrl).toBe('https://test.com');
+      expect(pwa.logLevel).toBe('debug');
+      expect(pwa.controls).toBeDefined();
+      // Shell-only keys should be removed
+      expect(pwa.serverPort).toBeUndefined();
+      expect(pwa.kioskMode).toBeUndefined();
+      expect(pwa.fullscreen).toBeUndefined();
+      expect(pwa.hideMouseCursor).toBeUndefined();
+      expect(pwa.width).toBeUndefined();
+      expect(pwa.height).toBeUndefined();
+      expect(pwa.relaxSslCerts).toBeUndefined();
+    });
+
+    it('should pass through apiClientId and apiClientSecret', () => {
+      const full = {
+        cmsUrl: 'https://test.com',
+        apiClientId: 'client-123',
+        apiClientSecret: 'secret-456',
+        serverPort: 8765,
+      };
+
+      const pwa = extractPwaConfig(full);
+
+      expect(pwa.apiClientId).toBe('client-123');
+      expect(pwa.apiClientSecret).toBe('secret-456');
+      expect(pwa.serverPort).toBeUndefined();
+    });
+
+    it('should accept extra shell keys to exclude', () => {
+      const full = {
+        cmsUrl: 'https://test.com',
+        autoLaunch: true,
+        logLevel: 'debug',
+      };
+
+      const pwa = extractPwaConfig(full, ['autoLaunch']);
+
+      expect(pwa.cmsUrl).toBe('https://test.com');
+      expect(pwa.logLevel).toBe('debug');
+      expect(pwa.autoLaunch).toBeUndefined();
+    });
+
+    it('should return undefined for empty config', () => {
+      expect(extractPwaConfig({})).toBeUndefined();
+    });
+  });
 });

package/src/idb.js

@@ -35,3 +35,57 @@ export function openIDB(dbName, version, storeName, options = {}) {
     req.onerror = () => reject(req.error);
   });
 }
+
+/**
+ * Query records from an IndexedDB index with a cursor, up to a limit.
+ * @param {IDBDatabase} db - IndexedDB database instance
+ * @param {string} storeName - Object store name
+ * @param {string} indexName - Index name
+ * @param {any} value - Key to query (passed to openCursor)
+ * @param {number} limit - Maximum records to return
+ * @returns {Promise<Array>}
+ */
+export function queryByIndex(db, storeName, indexName, value, limit) {
+  return new Promise((resolve, reject) => {
+    const tx = db.transaction([storeName], 'readonly');
+    const index = tx.objectStore(storeName).index(indexName);
+    const request = index.openCursor(value);
+    const results = [];
+
+    request.onsuccess = (event) => {
+      const cursor = event.target.result;
+      if (cursor && results.length < limit) {
+        results.push(cursor.value);
+        cursor.continue();
+      } else {
+        resolve(results);
+      }
+    };
+    request.onerror = () => reject(new Error(`Index query failed: ${request.error}`));
+  });
+}
+
+/**
+ * Delete records by ID from an IndexedDB object store.
+ * @param {IDBDatabase} db - IndexedDB database instance
+ * @param {string} storeName - Object store name
+ * @param {Array} ids - Array of record IDs to delete
+ * @returns {Promise<number>} Number of deleted records
+ */
+export function deleteByIds(db, storeName, ids) {
+  return new Promise((resolve, reject) => {
+    const tx = db.transaction([storeName], 'readwrite');
+    const store = tx.objectStore(storeName);
+    let deleted = 0;
+
+    for (const id of ids) {
+      if (id) {
+        const req = store.delete(id);
+        req.onsuccess = () => { deleted++; };
+      }
+    }
+
+    tx.oncomplete = () => resolve(deleted);
+    tx.onerror = () => reject(new Error(`Delete failed: ${tx.error}`));
+  });
+}

package/src/index.js

@@ -6,9 +6,9 @@ export const VERSION = pkg.version;
 export { createLogger, setLogLevel, getLogLevel, isDebug, applyCmsLogLevel, mapCmsLogLevel, registerLogSink, unregisterLogSink, LOG_LEVELS } from './logger.js';
 export { EventEmitter } from './event-emitter.js';
 import { config as _config } from './config.js';
-export { config, SHELL_ONLY_KEYS, extractPwaConfig, computeCmsId, fnvHash, warnPlatformMismatch } from './config.js';
+export { config, SHELL_ONLY_KEYS, extractPwaConfig, computeCmsId, warnPlatformMismatch } from './config.js';
 export { fetchWithRetry } from './fetch-retry.js';
-export { openIDB } from './idb.js';
+export { openIDB, queryByIndex, deleteByIds } from './idb.js';
 export { CmsApiClient, CmsApiError } from './cms-api.js';
 
 /**