@xiboplayer/stats 0.7.1 → 0.7.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xiboplayer/stats",
-  "version": "0.7.1",
+  "version": "0.7.3",
   "description": "Proof of play tracking, stats reporting, and CMS logging",
   "type": "module",
   "main": "./src/index.js",
@@ -10,11 +10,11 @@
     "./collector": "./src/stats-collector.js"
   },
   "dependencies": {
-    "@xiboplayer/utils": "0.7.1"
+    "@xiboplayer/utils": "0.7.3"
   },
   "devDependencies": {
-    "vitest": "^2.0.0",
-    "fake-indexeddb": "^5.0.2"
+    "fake-indexeddb": "^5.0.2",
+    "vitest": "^2.1.9"
   },
   "keywords": [
     "xibo",

package/src/format-helpers.js

@@ -0,0 +1,46 @@
+// SPDX-License-Identifier: AGPL-3.0-or-later
+// Copyright (c) 2024-2026 Pau Aliagas <linuxnow@gmail.com>
+/**
+ * Shared formatting helpers for stats and log XML serialization.
+ *
+ * @module @xiboplayer/stats/format-helpers
+ */
+
+/**
+ * Format Date object as "YYYY-MM-DD HH:MM:SS"
+ * @param {Date|string|number} date
+ * @returns {string}
+ */
+export function formatDateTime(date) {
+  if (!(date instanceof Date)) {
+    date = new Date(date);
+  }
+
+  const year = date.getFullYear();
+  const month = String(date.getMonth() + 1).padStart(2, '0');
+  const day = String(date.getDate()).padStart(2, '0');
+  const hours = String(date.getHours()).padStart(2, '0');
+  const minutes = String(date.getMinutes()).padStart(2, '0');
+  const seconds = String(date.getSeconds()).padStart(2, '0');
+
+  return `${year}-${month}-${day} ${hours}:${minutes}:${seconds}`;
+}
+
+/**
+ * Escape XML special characters in a string.
+ * Returns non-string values unchanged.
+ * @param {string|*} str
+ * @returns {string|*}
+ */
+export function escapeXml(str) {
+  if (typeof str !== 'string') {
+    return str;
+  }
+
+  return str
+    .replace(/&/g, '&amp;')
+    .replace(/</g, '&lt;')
+    .replace(/>/g, '&gt;')
+    .replace(/"/g, '&quot;')
+    .replace(/'/g, '&apos;');
+}

package/src/log-reporter.js

@@ -9,7 +9,8 @@
  * @module @xiboplayer/stats/logger
  */
 
-import { createLogger, openIDB } from '@xiboplayer/utils';
+import { createLogger, openIDB, queryByIndex, deleteByIds } from '@xiboplayer/utils';
+import { formatDateTime, escapeXml } from './format-helpers.js';
 
 const log = createLogger('@xiboplayer/stats');
 
@@ -248,45 +249,14 @@ export class LogReporter {
     return this.log('debug', message, category);
   }
 
-  /** Query records from an IndexedDB index with a cursor, up to a limit. */
+  /** @see queryByIndex in @xiboplayer/utils/idb */
   _queryByIndex(storeName, indexName, keyValue, limit) {
-    return new Promise((resolve, reject) => {
-      const tx = this.db.transaction([storeName], 'readonly');
-      const index = tx.objectStore(storeName).index(indexName);
-      const request = index.openCursor(keyValue);
-      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}`));
-    });
+    return queryByIndex(this.db, storeName, indexName, keyValue, limit);
   }
 
-  /** Delete records by ID from an IndexedDB object store. */
+  /** @see deleteByIds in @xiboplayer/utils/idb */
   _deleteByIds(storeName, records) {
-    return new Promise((resolve, reject) => {
-      const tx = this.db.transaction([storeName], 'readwrite');
-      const store = tx.objectStore(storeName);
-      let deleted = 0;
-
-      for (const record of records) {
-        if (record.id) {
-          const req = store.delete(record.id);
-          req.onsuccess = () => { deleted++; };
-          req.onerror = () => { log.error(`Failed to delete ${record.id}:`, req.error); };
-        }
-      }
-
-      tx.oncomplete = () => resolve(deleted);
-      tx.onerror = () => reject(new Error(`Delete failed: ${tx.error}`));
-    });
+    return deleteByIds(this.db, storeName, records.map(r => r.id));
   }
 
   /**
@@ -308,25 +278,6 @@ export class LogReporter {
     return logs;
   }
 
-  /**
-   * Count unsubmitted logs in the database.
-   * @returns {Promise<number>}
-   */
-  async _countUnsubmitted() {
-    return new Promise((resolve) => {
-      try {
-        const transaction = this.db.transaction([LOGS_STORE], 'readonly');
-        const store = transaction.objectStore(LOGS_STORE);
-        const index = store.index('submitted');
-        const request = index.count(IDBKeyRange.only(0));
-        request.onsuccess = () => resolve(request.result);
-        request.onerror = () => resolve(0);
-      } catch (_) {
-        resolve(0);
-      }
-    });
-  }
-
   /**
    * Clear submitted logs from database
    *
@@ -562,38 +513,3 @@ export function formatFaults(faults) {
   })));
 }
 
-/**
- * Format Date object as "YYYY-MM-DD HH:MM:SS"
- * @private
- */
-function formatDateTime(date) {
-  if (!(date instanceof Date)) {
-    date = new Date(date);
-  }
-
-  const year = date.getFullYear();
-  const month = String(date.getMonth() + 1).padStart(2, '0');
-  const day = String(date.getDate()).padStart(2, '0');
-  const hours = String(date.getHours()).padStart(2, '0');
-  const minutes = String(date.getMinutes()).padStart(2, '0');
-  const seconds = String(date.getSeconds()).padStart(2, '0');
-
-  return `${year}-${month}-${day} ${hours}:${minutes}:${seconds}`;
-}
-
-/**
- * Escape XML special characters
- * @private
- */
-function escapeXml(str) {
-  if (typeof str !== 'string') {
-    return str;
-  }
-
-  return str
-    .replace(/&/g, '&amp;')
-    .replace(/</g, '&lt;')
-    .replace(/>/g, '&gt;')
-    .replace(/"/g, '&quot;')
-    .replace(/'/g, '&apos;');
-}

package/src/stats-collector.js

@@ -9,7 +9,8 @@
  * @module @xiboplayer/stats/collector
  */
 
-import { createLogger, openIDB } from '@xiboplayer/utils';
+import { createLogger, openIDB, queryByIndex, deleteByIds } from '@xiboplayer/utils';
+import { formatDateTime, escapeXml } from './format-helpers.js';
 
 const log = createLogger('@xiboplayer/stats');
 
@@ -309,57 +310,14 @@ export class StatsCollector {
     }
   }
 
-  /**
-   * Query records from an IndexedDB index with a cursor, up to a limit.
-   * @param {string} storeName - Object store name
-   * @param {string} indexName - Index name
-   * @param {any} keyValue - Key to query (passed to openCursor)
-   * @param {number} limit - Maximum records to return
-   * @returns {Promise<Array>}
-   */
+  /** @see queryByIndex in @xiboplayer/utils/idb */
   _queryByIndex(storeName, indexName, keyValue, limit) {
-    return new Promise((resolve, reject) => {
-      const tx = this.db.transaction([storeName], 'readonly');
-      const index = tx.objectStore(storeName).index(indexName);
-      const request = index.openCursor(keyValue);
-      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}`));
-    });
+    return queryByIndex(this.db, storeName, indexName, keyValue, limit);
   }
 
-  /**
-   * Delete records by ID from an IndexedDB object store.
-   * @param {string} storeName - Object store name
-   * @param {Array} records - Records with .id property
-   * @returns {Promise<number>} Number of deleted records
-   */
+  /** @see deleteByIds in @xiboplayer/utils/idb */
   _deleteByIds(storeName, records) {
-    return new Promise((resolve, reject) => {
-      const tx = this.db.transaction([storeName], 'readwrite');
-      const store = tx.objectStore(storeName);
-      let deleted = 0;
-
-      for (const record of records) {
-        if (record.id) {
-          const req = store.delete(record.id);
-          req.onsuccess = () => { deleted++; };
-          req.onerror = () => { log.error(`Failed to delete ${record.id}:`, req.error); };
-        }
-      }
-
-      tx.oncomplete = () => resolve(deleted);
-      tx.onerror = () => reject(new Error(`Delete failed: ${tx.error}`));
-    });
+    return deleteByIds(this.db, storeName, records.map(r => r.id));
   }
 
   /**
@@ -704,38 +662,3 @@ export function formatStats(stats) {
   return `<stats>\n${statElements.join('\n')}\n</stats>`;
 }
 
-/**
- * Format Date object as "YYYY-MM-DD HH:MM:SS"
- * @private
- */
-function formatDateTime(date) {
-  if (!(date instanceof Date)) {
-    date = new Date(date);
-  }
-
-  const year = date.getFullYear();
-  const month = String(date.getMonth() + 1).padStart(2, '0');
-  const day = String(date.getDate()).padStart(2, '0');
-  const hours = String(date.getHours()).padStart(2, '0');
-  const minutes = String(date.getMinutes()).padStart(2, '0');
-  const seconds = String(date.getSeconds()).padStart(2, '0');
-
-  return `${year}-${month}-${day} ${hours}:${minutes}:${seconds}`;
-}
-
-/**
- * Escape XML special characters
- * @private
- */
-function escapeXml(str) {
-  if (typeof str !== 'string') {
-    return str;
-  }
-
-  return str
-    .replace(/&/g, '&amp;')
-    .replace(/</g, '&lt;')
-    .replace(/>/g, '&gt;')
-    .replace(/"/g, '&quot;')
-    .replace(/'/g, '&apos;');
-}