@xiboplayer/utils 0.2.0 → 0.3.0

package/README.md

@@ -1,15 +1,16 @@
-# @xiboplayer/utils Documentation
+# @xiboplayer/utils
 
-**Shared utilities for all Xibo Player packages.**
+**Shared utilities for all XiboPlayer SDK packages.**
 
 ## Overview
 
-Common utilities:
+Foundation utilities used across the SDK:
 
-- **Logger** - Structured logging
-- **EventEmitter** - Pub/sub event bus
-- **Config** - Configuration management
-- **Helpers** - Utility functions
+- **Logger** — structured logging with configurable levels (`DEBUG`, `INFO`, `WARNING`, `ERROR`) and per-module tags
+- **EventEmitter** — lightweight pub/sub event system
+- **fetchWithRetry** — HTTP fetch with exponential backoff, jitter, and configurable retries
+- **CMS REST client** — JSON API client with ETag caching
+- **Config** — hardware key management and IndexedDB-backed configuration
 
 ## Installation
 
@@ -20,42 +21,27 @@ npm install @xiboplayer/utils
 ## Usage
 
 ```javascript
-import { Logger, EventEmitter } from '@xiboplayer/utils';
+import { createLogger, EventEmitter, fetchWithRetry } from '@xiboplayer/utils';
 
-// Logger
-const log = new Logger('MyModule');
-log.info('Message', { data: 123 });
+const log = createLogger('my-module');
+log.info('Starting...');
+log.debug('Detailed info');
 
-// EventEmitter
 const emitter = new EventEmitter();
 emitter.on('event', (data) => console.log(data));
-emitter.emit('event', { foo: 'bar' });
-```
-
-## API Reference
-
-### Logger
-
-```javascript
-logger.debug(message, data)
-logger.info(message, data)
-logger.warn(message, data)
-logger.error(message, data)
-```
 
-### EventEmitter
-
-```javascript
-emitter.on(event, callback)
-emitter.once(event, callback)
-emitter.off(event, callback)
-emitter.emit(event, data)
+const response = await fetchWithRetry(url, { retries: 3 });
 ```
 
-## Dependencies
+## Exports
 
-None (zero dependencies)
+| Export | Description |
+|--------|-------------|
+| `createLogger(tag)` | Create a tagged logger instance |
+| `EventEmitter` | Pub/sub event emitter |
+| `fetchWithRetry(url, opts)` | Fetch with exponential backoff |
+| `Config` | Hardware key and IndexedDB config management |
 
 ---
 
-**Package Version**: 1.0.0
+**Part of the [XiboPlayer SDK](https://github.com/linuxnow/xiboplayer)**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xiboplayer/utils",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Shared utilities for Xibo Player packages",
   "type": "module",
   "main": "./src/index.js",

package/src/index.js

@@ -1,4 +1,6 @@
 // @xiboplayer/utils - Shared utilities
+import pkg from '../package.json' with { type: 'json' };
+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';
 export { config } from './config.js';

package/src/logger.js

@@ -7,7 +7,10 @@
  *   1. URL param ?logLevel=DEBUG
  *   2. localStorage xibo_log_level
  *   3. CMS setting via RegisterDisplay (call applyCmsLogLevel())
- *   4. Default: DEBUG on localhost, INFO in production
+ *   4. Default: WARNING (production-safe)
+ *
+ * For development, pass ?logLevel=DEBUG in the URL.
+ * Electron's --dev flag does this automatically.
  *
  * Loggers created without an explicit level are REACTIVE — they follow
  * the global level at call time, so setLogLevel() affects all of them.
@@ -93,7 +96,7 @@ class Logger {
 
 // Global log level configuration
 const globalConfig = {
-  level: LOG_LEVELS.INFO, // Default: INFO and above
+  level: LOG_LEVELS.WARNING, // Default: WARNING (production-safe)
 
   setGlobalLevel(level) {
     if (typeof level === 'string') {
@@ -114,6 +117,8 @@ const globalConfig = {
 let hasLocalOverride = false;
 
 // Set global level from environment or localStorage
+// Default: WARNING (production-safe). Use ?logLevel=DEBUG for development,
+// or let the CMS override via applyCmsLogLevel().
 if (typeof window !== 'undefined') {
   const urlParams = new URLSearchParams(window.location.search);
   const urlLevel = urlParams.get('logLevel');
@@ -125,12 +130,8 @@ if (typeof window !== 'undefined') {
   } else if (storageLevel) {
     globalConfig.setGlobalLevel(storageLevel);
     hasLocalOverride = true;
-  } else if (window.location.hostname === 'localhost' || window.location.hostname === '127.0.0.1') {
-    // Development mode - debug logging
-    globalConfig.setGlobalLevel('DEBUG');
   } else {
-    // Production mode - INFO by default (CMS can override later)
-    globalConfig.setGlobalLevel('INFO');
+    globalConfig.setGlobalLevel('WARNING');
   }
 }
 

package/src/logger.test.js

@@ -33,13 +33,13 @@ describe('Logger', () => {
   });
 
   describe('Logger Creation', () => {
-    it('should create logger with default INFO level', () => {
+    it('should create logger with default WARNING level', () => {
       const logger = createLogger('TestModule');
 
       expect(logger.name).toBe('TestModule');
       // When no explicit level is given, logger follows global level (useGlobal=true)
       // so logger.level is undefined — check getEffectiveLevel() instead
-      expect(logger.getEffectiveLevel()).toBeLessThanOrEqual(LOG_LEVELS.INFO);
+      expect(logger.getEffectiveLevel()).toBeLessThanOrEqual(LOG_LEVELS.WARNING);
     });
 
     it('should create logger with custom level', () => {