@xiboplayer/utils 0.5.19 → 0.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xiboplayer/utils",
-  "version": "0.5.19",
+  "version": "0.6.0",
   "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.5.19"
+    "@xiboplayer/crypto": "0.6.0"
   },
   "devDependencies": {
     "vitest": "^2.0.0"

package/src/config.js

@@ -334,3 +334,45 @@ export class Config {
 }
 
 export const config = new Config();
+
+/**
+ * Shell-only config keys common to ALL player shells (Electron, Chromium, etc.).
+ * These control the native shell window/process and must NOT be forwarded to the PWA.
+ *
+ * Each shell may have additional shell-specific keys — pass them as extraShellKeys
+ * to extractPwaConfig().
+ *
+ * Electron extras:  autoLaunch
+ * Chromium extras:  browser, extraBrowserFlags, relaxSslCerts
+ */
+export const SHELL_ONLY_KEYS = new Set([
+  'serverPort',
+  'kioskMode',
+  'fullscreen',
+  'hideMouseCursor',
+  'preventSleep',
+  'width',
+  'height',
+]);
+
+/**
+ * Extract PWA config from a full shell config.json.
+ *
+ * Uses a deny-list approach: filters out shell-only keys, passes everything else.
+ * This is future-proof — new config.json fields automatically reach the PWA
+ * without code changes in each shell.
+ *
+ * @param {Object} config - Full config object from config.json
+ * @param {Iterable<string>} [extraShellKeys] - Additional shell-specific keys to exclude
+ * @returns {Object} Config to pass to the PWA (via proxy pwaConfig)
+ */
+export function extractPwaConfig(config, extraShellKeys) {
+  const exclude = new Set([...SHELL_ONLY_KEYS, ...(extraShellKeys || [])]);
+  const pwaConfig = {};
+  for (const [key, value] of Object.entries(config)) {
+    if (!exclude.has(key)) {
+      pwaConfig[key] = value;
+    }
+  }
+  return Object.keys(pwaConfig).length > 0 ? pwaConfig : undefined;
+}

package/src/fetch-retry.js

@@ -83,6 +83,17 @@ export async function fetchWithRetry(url, options = {}, retryOptions = {}) {
       lastResponse = response;
       lastError = new Error(`HTTP ${response.status}: ${response.statusText}`);
       lastError.status = response.status;
+
+      // Respect Retry-After on 503 Service Unavailable (e.g. CMS cache warming)
+      if (response.status === 503 && attempt < maxRetries) {
+        const retryAfter = response.headers.get('Retry-After');
+        if (retryAfter) {
+          const delayMs = parseRetryAfter(retryAfter);
+          log.debug(`503 Service Unavailable, Retry-After: ${retryAfter} (${delayMs}ms)`);
+          await new Promise(resolve => setTimeout(resolve, delayMs));
+          continue;
+        }
+      }
     } catch (error) {
       // Network error — retryable
       lastError = error;

package/src/index.d.ts

@@ -1,4 +1,5 @@
 export const VERSION: string;
+export let PLAYER_API: string;
 
 export interface Logger {
   debug(...args: any[]): void;
@@ -56,6 +57,17 @@ export class Config {
 
 export const config: Config;
 
+export const SHELL_ONLY_KEYS: Set<string>;
+
+/**
+ * Extract PWA config from a full shell config.json.
+ * Filters out shell-only keys, passes everything else to the PWA.
+ */
+export function extractPwaConfig(
+  config: Record<string, any>,
+  extraShellKeys?: Iterable<string>
+): Record<string, any> | undefined;
+
 export function fetchWithRetry(
   url: string,
   options?: RequestInit,

package/src/index.js

@@ -3,6 +3,30 @@ 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';
+import { config as _config } from './config.js';
+export { config, SHELL_ONLY_KEYS, extractPwaConfig } from './config.js';
 export { fetchWithRetry } from './fetch-retry.js';
 export { CmsApiClient, CmsApiError } from './cms-api.js';
+
+/**
+ * CMS Player API base path — all media, dependencies, and widgets are served
+ * under this prefix.
+ *
+ * Default: '/api/v2/player' (standalone index.php endpoint).
+ * Override: set `playerApiBase` in config.json / localStorage, or call
+ *           setPlayerApi('/new/path') before route registration (proxy).
+ *
+ * Browser: reads from config.data.playerApiBase at import time.
+ * Node:    call setPlayerApi() before createProxyApp().
+ */
+const DEFAULT_PLAYER_API = '/api/v2/player';
+let _playerApi = _config.data?.playerApiBase || DEFAULT_PLAYER_API;
+
+/** Current Player API base path (no trailing slash). */
+export let PLAYER_API = _playerApi;
+
+/** Override the Player API base path at runtime (call before route registration). */
+export function setPlayerApi(base) {
+  _playerApi = base.replace(/\/+$/, '');
+  PLAYER_API = _playerApi;
+}