@xiboplayer/utils 0.4.9 → 0.5.1

package/package.json

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

package/src/config.js

@@ -12,7 +12,7 @@ const HW_DB_VERSION = 1;
 
 /**
  * Check for environment variable config (highest priority).
- * Env vars: CMS_ADDRESS, CMS_KEY, DISPLAY_NAME, HARDWARE_KEY, XMR_CHANNEL
+ * Env vars: CMS_URL, CMS_KEY, DISPLAY_NAME, HARDWARE_KEY, XMR_CHANNEL
  * Returns config object if any env vars are set, null otherwise.
  */
 function loadFromEnv() {
@@ -20,7 +20,7 @@ function loadFromEnv() {
   const env = typeof process !== 'undefined' && process.env ? process.env : {};
 
   const envConfig = {
-    cmsAddress: env.CMS_ADDRESS || env.CMS_URL || '',
+    cmsUrl: env.CMS_URL || '',
     cmsKey: env.CMS_KEY || '',
     displayName: env.DISPLAY_NAME || '',
     hardwareKey: env.HARDWARE_KEY || '',
@@ -53,51 +53,49 @@ export class Config {
 
     // Priority 2: localStorage (browser)
     if (typeof localStorage === 'undefined') {
-      return { cmsAddress: '', cmsKey: '', displayName: '', hardwareKey: '', xmrChannel: '' };
+      return { cmsUrl: '', cmsKey: '', displayName: '', hardwareKey: '', xmrChannel: '' };
     }
 
     // Try to load from localStorage
     const json = localStorage.getItem(STORAGE_KEY);
+    let config = {};
 
     if (json) {
       try {
-        const config = JSON.parse(json);
-
-        // CRITICAL: Hardware key must persist
-        if (!config.hardwareKey || config.hardwareKey.length < 10) {
-          console.error('[Config] CRITICAL: Invalid/missing hardwareKey in localStorage!');
-          config.hardwareKey = this.generateStableHardwareKey();
-          localStorage.setItem(STORAGE_KEY, JSON.stringify(config));
-          this._backupHardwareKey(config.hardwareKey);
-        } else {
-          console.log('[Config] ✓ Loaded existing hardwareKey:', config.hardwareKey);
-        }
-
-        return config;
+        config = JSON.parse(json);
       } catch (e) {
-        console.error('[Config] Failed to parse config from localStorage:', e);
-        // Fall through to create new config
+        console.error('[Config] Failed to parse localStorage config:', e);
       }
     }
 
-    // No config in localStorage - first time setup
-    console.log('[Config] No config in localStorage - first time setup');
+    // ── Single validation gate (same path for fresh + pre-seeded) ──
+    let changed = false;
+
+    if (!config.hardwareKey || config.hardwareKey.length < 10) {
+      console.warn('[Config] Missing/invalid hardwareKey — generating');
+      config.hardwareKey = this.generateStableHardwareKey();
+      this._backupHardwareKey(config.hardwareKey);
+      changed = true;
+    } else {
+      console.log('[Config] ✓ Loaded existing hardwareKey:', config.hardwareKey);
+    }
+
+    if (!config.xmrChannel) {
+      console.warn('[Config] Missing xmrChannel — generating');
+      config.xmrChannel = this.generateXmrChannel();
+      changed = true;
+    }
 
-    const newConfig = {
-      cmsAddress: '',
-      cmsKey: '',
-      displayName: '',
-      hardwareKey: this.generateStableHardwareKey(),
-      xmrChannel: this.generateXmrChannel()
-    };
+    // Ensure optional fields have defaults
+    config.cmsUrl = config.cmsUrl || '';
+    config.cmsKey = config.cmsKey || '';
+    config.displayName = config.displayName || '';
 
-    // Save immediately
-    localStorage.setItem(STORAGE_KEY, JSON.stringify(newConfig));
-    this._backupHardwareKey(newConfig.hardwareKey);
-    console.log('[Config] ✓ Saved new config to localStorage');
-    console.log('[Config] Hardware key will persist across reloads:', newConfig.hardwareKey);
+    if (changed) {
+      localStorage.setItem(STORAGE_KEY, JSON.stringify(config));
+    }
 
-    return newConfig;
+    return config;
   }
 
   /**
@@ -188,7 +186,7 @@ export class Config {
   }
 
   isConfigured() {
-    return !!(this.data.cmsAddress && this.data.cmsKey && this.data.displayName);
+    return !!(this.data.cmsUrl && this.data.cmsKey && this.data.displayName);
   }
 
   generateStableHardwareKey() {
@@ -302,8 +300,8 @@ export class Config {
     return result.substring(0, 32);
   }
 
-  get cmsAddress() { return this.data.cmsAddress; }
-  set cmsAddress(val) { this.data.cmsAddress = val; this.save(); }
+  get cmsUrl() { return this.data.cmsUrl; }
+  set cmsUrl(val) { this.data.cmsUrl = val; this.save(); }
 
   get cmsKey() { return this.data.cmsKey; }
   set cmsKey(val) { this.data.cmsKey = val; this.save(); }
@@ -320,7 +318,14 @@ export class Config {
     }
     return this.data.hardwareKey;
   }
-  get xmrChannel() { return this.data.xmrChannel; }
+  get xmrChannel() {
+    if (!this.data.xmrChannel) {
+      console.warn('[Config] xmrChannel missing at access time — generating');
+      this.data.xmrChannel = this.generateXmrChannel();
+      this.save();
+    }
+    return this.data.xmrChannel;
+  }
   get xmrPubKey() { return this.data.xmrPubKey || ''; }
   get xmrPrivKey() { return this.data.xmrPrivKey || ''; }
 

package/src/config.test.js

@@ -76,7 +76,7 @@ describe('Config', () => {
       config = new Config();
 
       expect(config.data).toBeDefined();
-      expect(config.data.cmsAddress).toBe('');
+      expect(config.data.cmsUrl).toBe('');
       expect(config.data.cmsKey).toBe('');
       expect(config.data.displayName).toBe('');
       expect(config.data.hardwareKey).toMatch(/^pwa-/);
@@ -100,7 +100,7 @@ describe('Config', () => {
 
     it('should load existing config from localStorage', () => {
       const existingConfig = {
-        cmsAddress: 'https://test.cms.com',
+        cmsUrl: 'https://test.cms.com',
         cmsKey: 'test-key',
         displayName: 'Test Display',
         hardwareKey: 'pwa-existinghardwarekey1234567',
@@ -116,7 +116,7 @@ describe('Config', () => {
 
     it('should regenerate hardware key if invalid in stored config', () => {
       const invalidConfig = {
-        cmsAddress: 'https://test.cms.com',
+        cmsUrl: 'https://test.cms.com',
         cmsKey: 'test-key',
         displayName: 'Test Display',
         hardwareKey: 'short', // Invalid: too short
@@ -298,20 +298,20 @@ describe('Config', () => {
       config = new Config();
     });
 
-    it('should get/set cmsAddress', () => {
-      expect(config.cmsAddress).toBe('');
+    it('should get/set cmsUrl', () => {
+      expect(config.cmsUrl).toBe('');
 
-      config.cmsAddress = 'https://new.cms.com';
+      config.cmsUrl = 'https://new.cms.com';
 
-      expect(config.cmsAddress).toBe('https://new.cms.com');
-      expect(config.data.cmsAddress).toBe('https://new.cms.com');
+      expect(config.cmsUrl).toBe('https://new.cms.com');
+      expect(config.data.cmsUrl).toBe('https://new.cms.com');
     });
 
-    it('should save to localStorage when cmsAddress set', () => {
-      config.cmsAddress = 'https://test.com';
+    it('should save to localStorage when cmsUrl set', () => {
+      config.cmsUrl = 'https://test.com';
 
       const stored = JSON.parse(mockLocalStorage.getItem('xibo_config'));
-      expect(stored.cmsAddress).toBe('https://test.com');
+      expect(stored.cmsUrl).toBe('https://test.com');
     });
 
     it('should get/set cmsKey', () => {
@@ -351,8 +351,8 @@ describe('Config', () => {
       expect(config.isConfigured()).toBe(false);
     });
 
-    it('should return false when only cmsAddress set', () => {
-      config.cmsAddress = 'https://test.com';
+    it('should return false when only cmsUrl set', () => {
+      config.cmsUrl = 'https://test.com';
 
       expect(config.isConfigured()).toBe(false);
     });
@@ -370,7 +370,7 @@ describe('Config', () => {
     });
 
     it('should return true when all required fields set', () => {
-      config.cmsAddress = 'https://test.com';
+      config.cmsUrl = 'https://test.com';
       config.cmsKey = 'test-key';
       config.displayName = 'Test Display';
 
@@ -384,21 +384,21 @@ describe('Config', () => {
     });
 
     it('should save current config to localStorage', () => {
-      config.data.cmsAddress = 'https://manual.com';
+      config.data.cmsUrl = 'https://manual.com';
       config.data.cmsKey = 'manual-key';
 
       config.save();
 
       const stored = JSON.parse(mockLocalStorage.getItem('xibo_config'));
-      expect(stored.cmsAddress).toBe('https://manual.com');
+      expect(stored.cmsUrl).toBe('https://manual.com');
       expect(stored.cmsKey).toBe('manual-key');
     });
 
     it('should auto-save when setters used', () => {
-      config.cmsAddress = 'https://auto.com';
+      config.cmsUrl = 'https://auto.com';
 
       const stored = JSON.parse(mockLocalStorage.getItem('xibo_config'));
-      expect(stored.cmsAddress).toBe('https://auto.com');
+      expect(stored.cmsUrl).toBe('https://auto.com');
     });
   });
 
@@ -420,7 +420,7 @@ describe('Config', () => {
   describe('Edge Cases', () => {
     it('should handle missing hardwareKey in loaded config', () => {
       mockLocalStorage.setItem('xibo_config', JSON.stringify({
-        cmsAddress: 'https://test.com',
+        cmsUrl: 'https://test.com',
         cmsKey: 'test-key',
         displayName: 'Test'
         // hardwareKey missing
@@ -434,7 +434,7 @@ describe('Config', () => {
 
     it('should handle null values in config', () => {
       mockLocalStorage.setItem('xibo_config', JSON.stringify({
-        cmsAddress: null,
+        cmsUrl: null,
         cmsKey: null,
         displayName: null,
         hardwareKey: 'pwa-1234567812344567890123456789',
@@ -444,7 +444,8 @@ describe('Config', () => {
       config = new Config();
 
       expect(config.isConfigured()).toBe(false);
-      expect(config.cmsAddress).toBeNull();
+      // null values are normalized to empty strings by the validation gate
+      expect(config.cmsUrl).toBe('');
     });
 
     it('should handle very long strings', () => {
@@ -478,13 +479,13 @@ describe('Config', () => {
 
     it('should persist configuration changes', () => {
       const config1 = new Config();
-      config1.cmsAddress = 'https://persist.com';
+      config1.cmsUrl = 'https://persist.com';
       config1.cmsKey = 'persist-key';
       config1.displayName = 'Persist Display';
 
       const config2 = new Config();
 
-      expect(config2.cmsAddress).toBe('https://persist.com');
+      expect(config2.cmsUrl).toBe('https://persist.com');
       expect(config2.cmsKey).toBe('persist-key');
       expect(config2.displayName).toBe('Persist Display');
     });