@vpmedia/simplify 1.65.0 → 1.67.0

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+## [1.67.0] - 2026-02-04
+
+### 🚀 Features
+
+- Added es6 event emitter implementation
+
+### 💼 Other
+
+- *(deps)* Bump dependency versions
+- *(deps)* Bump dependency versions
+- *(deps)* Bump dependency versions
+
+### 🚜 Refactor
+
+- Simplify purgeObject helper
+
+### ⚙️ Miscellaneous Tasks
+
+- Release
+- Fixed lint errors
+- *(release)* V1.67.0
+## [1.66.0] - 2026-01-30
+
+### ⚙️ Miscellaneous Tasks
+
+- Release
+- Added isOnline log info to fetch
+- *(release)* V1.66.0
 ## [1.65.0] - 2026-01-30
 
 ### 💼 Other

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vpmedia/simplify",
-  "version": "1.65.0",
+  "version": "1.67.0",
   "description": "@vpmedia/simplify",
   "author": "Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)",
   "license": "MIT",
@@ -25,20 +25,20 @@
     "@sentry/browser": "^10.38.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^20.3.1",
-    "@commitlint/config-conventional": "^20.3.1",
+    "@commitlint/cli": "^20.4.1",
+    "@commitlint/config-conventional": "^20.4.1",
     "@eslint/js": "^9.39.2",
-    "@types/node": "^25.1.0",
+    "@types/node": "^25.2.0",
     "@vitest/coverage-v8": "^4.0.18",
     "eslint": "^9.39.2",
     "eslint-plugin-jsdoc": "^62.5.0",
-    "eslint-plugin-oxlint": "^1.42.0",
+    "eslint-plugin-oxlint": "^1.43.0",
     "eslint-plugin-unicorn": "^62.0.0",
-    "globals": "^17.2.0",
-    "jsdom": "^27.4.0",
+    "globals": "^17.3.0",
+    "jsdom": "^28.0.0",
     "msw": "^2.12.7",
-    "oxlint": "^1.42.0",
-    "oxlint-tsgolint": "^0.11.3",
+    "oxlint": "^1.43.0",
+    "oxlint-tsgolint": "^0.11.4",
     "prettier": "^3.8.1",
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.54.0",

package/src/index.js

@@ -21,6 +21,7 @@ export { TypeCheckError } from './typecheck/TypeCheckError.js';
 export { typeCheck, typeCheckArray, typeCheckEnum } from './typecheck/util.js';
 export { delayPromise, loadJSON } from './util/async.js';
 export { getErrorDetails, getTypedError } from './util/error.js';
+export { EventEmitter3 } from './util/event_emitter.js';
 export { FetchError, fetchRetry, HTTP_0_ANY } from './util/fetch.js';
 export {
   deg2rad,

package/src/util/event_emitter.js

@@ -0,0 +1,198 @@
+/**
+ * @callback EventListener
+ * A function invoked when an event is emitted.
+ * @param {...any} args - Arguments passed from the emitter.
+ * @returns {void}
+ */
+
+/**
+ * Internal listener wrapper that stores metadata
+ * about a registered event listener.
+ */
+// oxlint-disable-next-line no-extraneous-class
+class Listener {
+  /**
+   * @param {EventListener} fn - The listener callback function.
+   * @param {any} context - The `this` value used when invoking the listener.
+   * @param {boolean} [once] - Whether the listener should be invoked only once.
+   */
+  constructor(fn, context, once = false) {
+    /** @type {EventListener} The listener callback */
+    this.fn = fn;
+
+    /** @type {any} Execution context for the callback */
+    this.context = context;
+
+    /** @type {boolean} Whether this listener is one-time */
+    this.once = once;
+  }
+}
+
+/**
+ * Event emitter implementation inspired by Node.js/EventEmitter3.
+ * Allows registering, emitting, and removing event listeners.
+ */
+export class EventEmitter3 {
+  #events;
+
+  constructor() {
+    /**
+     * Map of event name - array of listener wrappers.
+     * @type {Map<string | symbol, Listener[]>}
+     */
+    this.#events = new Map();
+  }
+
+  /**
+   * Get all registered event names.
+   * @returns {(string | symbol)[]} Array of event identifiers.
+   */
+  eventNames() {
+    return [...this.#events.keys()];
+  }
+
+  /**
+   * Get all listener functions registered for an event.
+   * @param {string | symbol} event - Event name.
+   * @returns {EventListener[]} List of listener callbacks.
+   */
+  listeners(event) {
+    const listeners = this.#events.get(event);
+    return listeners ? listeners.map((l) => l.fn) : [];
+  }
+
+  /**
+   * Get the number of listeners registered for an event.
+   * @param {string | symbol} event - Event name.
+   * @returns {number} Number of listeners.
+   */
+  listenerCount(event) {
+    const listeners = this.#events.get(event);
+    return listeners ? listeners.length : 0;
+  }
+
+  /**
+   * Emit an event, invoking all registered listeners
+   * with the provided arguments.
+   * @param {string | symbol} event - Event name.
+   * @param {...any} args - Arguments passed to listeners.
+   * @returns {boolean} True if the event had listeners, otherwise false.
+   */
+  emit(event, ...args) {
+    const listeners = this.#events.get(event);
+    if (!listeners || listeners.length === 0) {
+      return false;
+    }
+
+    // Clone to prevent mutation during iteration
+    // eslint-disable-next-line unicorn/no-useless-spread
+    for (const listener of [...listeners]) {
+      listener.fn.apply(listener.context, args);
+      if (listener.once) {
+        this.off(event, listener.fn, listener.context);
+      }
+    }
+
+    return true;
+  }
+
+  /**
+   * Internal helper for registering a listener.
+   * @param {string | symbol} event - Event name.
+   * @param {EventListener} fn - Listener callback.
+   * @param {any} context - Execution context for the callback.
+   * @param {boolean} once - Whether the listener is one-time.
+   * @returns {EventEmitter3} The emitter instance.
+   */
+  #addListener(event, fn, context, once) {
+    if (typeof fn !== 'function') {
+      throw new TypeError('Listener must be a function');
+    }
+
+    const listener = new Listener(fn, context ?? this, once);
+    const listeners = this.#events.get(event);
+
+    if (listeners) {
+      listeners.push(listener);
+    } else {
+      this.#events.set(event, [listener]);
+    }
+
+    return this;
+  }
+
+  /**
+   * Register a persistent listener for an event.
+   * @param {string | symbol} event - Event name.
+   * @param {EventListener} fn - Listener callback.
+   * @param {any} [context] - Optional execution context.
+   * @returns {EventEmitter3} The emitter instance.
+   */
+  on(event, fn, context) {
+    return this.#addListener(event, fn, context, false);
+  }
+
+  /**
+   * Register a one-time listener for an event.
+   * The listener is removed after its first invocation.
+   * @param {string | symbol} event - Event name.
+   * @param {EventListener} fn - Listener callback.
+   * @param {any} [context] - Optional execution context.
+   * @returns {EventEmitter3} The emitter instance.
+   */
+  once(event, fn, context) {
+    return this.#addListener(event, fn, context, true);
+  }
+
+  /**
+   * Remove a specific listener, or all listeners for an event.
+   * @param {string | symbol} event - Event name.
+   * @param {EventListener} [fn] - Listener callback to remove.
+   * @param {any} [context] - Context to match when removing.
+   * @returns {EventEmitter3} The emitter instance.
+   */
+  off(event, fn, context) {
+    if (!this.#events.has(event)) {
+      return this;
+    }
+
+    if (!fn) {
+      this.#events.delete(event);
+      return this;
+    }
+
+    const filtered = this.#events.get(event).filter((listener) => {
+      if (listener.fn !== fn) {
+        return true;
+      }
+      if (context !== undefined && listener.context !== context) {
+        return true;
+      }
+      return false;
+    });
+
+    if (filtered.length > 0) {
+      this.#events.set(event, filtered);
+    } else {
+      this.#events.delete(event);
+    }
+
+    return this;
+  }
+
+  /**
+   * Remove all listeners from the emitter,
+   * or all listeners for a specific event.
+   * @param {string | symbol} [event] - Optional event name.
+   * @returns {EventEmitter3} The emitter instance.
+   */
+  removeAllListeners(event) {
+    if (event === undefined) {
+      this.#events.clear();
+    } else {
+      this.#events.delete(event);
+    }
+
+    return this;
+  }
+}

package/src/util/event_emitter.test.js

@@ -0,0 +1,231 @@
+/* eslint-disable no-empty-function, no-invalid-this, func-names, func-style, unicorn/consistent-function-scoping */
+
+import { describe, it, expect } from 'vitest';
+import { EventEmitter3 } from './event_emitter.js';
+
+describe('EventEmitter3 basics', () => {
+  it('can be instantiated', () => {
+    const e = new EventEmitter3();
+    expect(e).toBeInstanceOf(EventEmitter3);
+  });
+
+  it('supports subclassing', () => {
+    class Beast extends EventEmitter3 {}
+    const beast = new Beast();
+
+    expect(beast).toBeInstanceOf(Beast);
+    expect(beast).toBeInstanceOf(EventEmitter3);
+  });
+});
+
+describe('emit()', () => {
+  it('returns false when no listeners exist', () => {
+    const e = new EventEmitter3();
+    expect(e.emit('foo')).toBe(false);
+  });
+
+  it('returns true when listeners exist', () => {
+    const e = new EventEmitter3();
+    e.on('foo', () => {});
+    expect(e.emit('foo')).toBe(true);
+  });
+
+  it('invokes listeners with provided arguments', async () => {
+    const e = new EventEmitter3();
+
+    await new Promise((resolve) => {
+      e.on('foo', (a, b) => {
+        expect(a).toBe(1);
+        expect(b).toBe(2);
+        resolve();
+      });
+
+      e.emit('foo', 1, 2);
+    });
+  });
+
+  it('binds the correct context', async () => {
+    const e = new EventEmitter3();
+    const ctx = { value: 42 };
+
+    await new Promise((resolve) => {
+      e.on(
+        'foo',
+        function () {
+          // @ts-expect-error
+          expect(this).toBe(ctx);
+          resolve();
+        },
+        ctx
+      );
+
+      e.emit('foo');
+    });
+  });
+
+  it('supports many listeners for the same event', () => {
+    const e = new EventEmitter3();
+    const calls = [];
+
+    e.on('foo', () => calls.push(1));
+    e.on('foo', () => calls.push(2));
+
+    e.emit('foo');
+
+    expect(calls).toEqual([1, 2]);
+  });
+});
+
+describe('once()', () => {
+  it('fires the listener only once', () => {
+    const e = new EventEmitter3();
+    let calls = 0;
+
+    e.once('foo', () => {
+      calls += 1;
+    });
+
+    e.emit('foo');
+    e.emit('foo');
+
+    expect(calls).toBe(1);
+    expect(e.listenerCount('foo')).toBe(0);
+  });
+
+  it('passes arguments correctly', async () => {
+    const e = new EventEmitter3();
+
+    await new Promise((resolve) => {
+      e.once('foo', (...args) => {
+        expect(args).toEqual([1, 2, 3]);
+        resolve();
+      });
+
+      e.emit('foo', 1, 2, 3);
+    });
+  });
+});
+
+describe('listeners() and listenerCount()', () => {
+  it('returns an empty array when no listeners exist', () => {
+    const e = new EventEmitter3();
+    expect(e.listeners('foo')).toEqual([]);
+    expect(e.listenerCount('foo')).toBe(0);
+  });
+
+  it('returns only listener functions (not internals)', () => {
+    const e = new EventEmitter3();
+    function fn() {}
+
+    e.on('foo', fn);
+
+    expect(e.listeners('foo')).toEqual([fn]);
+  });
+
+  it('does not expose internal listener storage', () => {
+    const e = new EventEmitter3();
+    function fn() {}
+
+    e.on('foo', fn);
+    const listeners = e.listeners('foo');
+    listeners.push(() => {});
+
+    expect(e.listeners('foo')).toEqual([fn]);
+  });
+});
+
+describe('off()', () => {
+  it('removes all listeners for an event when fn is omitted', () => {
+    const e = new EventEmitter3();
+
+    e.on('foo', () => {});
+    e.on('foo', () => {});
+
+    e.off('foo');
+
+    expect(e.listenerCount('foo')).toBe(0);
+  });
+
+  it('removes a specific listener', () => {
+    const e = new EventEmitter3();
+    function fn() {}
+
+    e.on('foo', fn);
+    e.off('foo', fn);
+
+    expect(e.listeners('foo')).toEqual([]);
+  });
+
+  it('removes listeners matching both function and context', () => {
+    const e = new EventEmitter3();
+    const ctx1 = {};
+    const ctx2 = {};
+    function fn() {}
+
+    e.on('foo', fn, ctx1);
+    e.on('foo', fn, ctx2);
+
+    e.off('foo', fn, ctx1);
+
+    expect(e.listenerCount('foo')).toBe(1);
+  });
+});
+
+describe('removeAllListeners()', () => {
+  it('removes listeners for a single event', () => {
+    const e = new EventEmitter3();
+
+    e.on('foo', () => {});
+    e.on('bar', () => {});
+
+    e.removeAllListeners('foo');
+
+    expect(e.listenerCount('foo')).toBe(0);
+    expect(e.listenerCount('bar')).toBe(1);
+  });
+
+  it('removes all listeners when no event is specified', () => {
+    const e = new EventEmitter3();
+
+    e.on('foo', () => {});
+    e.on('bar', () => {});
+
+    e.removeAllListeners();
+
+    expect(e.eventNames()).toEqual([]);
+  });
+});
+
+describe('eventNames()', () => {
+  it('returns an empty array when no events exist', () => {
+    const e = new EventEmitter3();
+    expect(e.eventNames()).toEqual([]);
+  });
+
+  it('returns all registered event names', () => {
+    const e = new EventEmitter3();
+
+    e.on('foo', () => {});
+    e.on('bar', () => {});
+
+    expect(e.eventNames()).toContain('foo');
+    expect(e.eventNames()).toContain('bar');
+  });
+
+  it('supports symbol event names', () => {
+    const e = new EventEmitter3();
+    const sym = Symbol('test');
+
+    e.on(sym, () => {});
+    expect(e.eventNames()).toContain(sym);
+  });
+
+  it('events map is instance field', () => {
+    const e1 = new EventEmitter3();
+    const e2 = new EventEmitter3();
+    e1.on('event', () => {});
+    expect(e1.listenerCount('event')).toBe(1);
+    expect(e1.listenerCount('no-event')).toBe(0);
+    expect(e2.listenerCount('event')).toBe(0);
+  });
+});

package/src/util/fetch.js

@@ -51,7 +51,8 @@ export const fetchRetry = async (resource, fetchOptions, retryOptions) => {
     HTTP_422_UNPROCESSABLE_CONTENT,
   ];
   while (retryOptions.numTries > 0) {
-    logger.info('request', { resource, fetchOptions, retryOptions });
+    const isOnline = globalThis.navigator?.onLine;
+    logger.info('request', { resource, fetchOptions, retryOptions, isOnline });
     const controller = new AbortController();
     const timeoutId = setTimeout(
       () => controller.abort(new DOMException('Fetch timed out', 'AbortError')),

package/src/util/object.js

@@ -8,9 +8,8 @@ export const purgeObject = (target) => {
   if (!target) {
     return;
   }
-  const reference = target;
   for (const entry of Object.keys(target)) {
-    reference[entry] = null;
+    target[entry] = null;
   }
 };
 
@@ -51,6 +50,7 @@ export const deepMerge = (target, source) => {
  * @returns {number} The sum value.
  */
 export const getObjArrayPropSum = (arr, prop) => arr.reduce((accumulator, object) => accumulator + object[prop], 0);
+
 /**
  * Get object value by path.
  * @param {object} obj - The source object to get the value from.

package/types/index.d.ts

@@ -10,6 +10,7 @@ export { OpenTelemetryLogHandler } from "./logging/OpenTelemetryLogHandler.js";
 export { SentryLogHandler } from "./logging/SentryLogHandler.js";
 export { typeChecker } from "./typecheck/TypeChecker.js";
 export { TypeCheckError } from "./typecheck/TypeCheckError.js";
+export { EventEmitter3 } from "./util/event_emitter.js";
 export { serverDataToState } from "./util/state.js";
 export { formatLogMessage, getLogLevelName } from "./logging/util.js";
 export { addPageLifecycleCallback, getDocumentState, getPageLifecycleEventEmitter, getPageLifecycleState, initPageLifecycle, isPageLifecycleInitialized } from "./pagelifecycle/util.js";

package/types/util/event_emitter.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Event emitter implementation inspired by Node.js/EventEmitter3.
+ * Allows registering, emitting, and removing event listeners.
+ */
+export class EventEmitter3 {
+    /**
+     * Get all registered event names.
+     * @returns {(string | symbol)[]} Array of event identifiers.
+     */
+    eventNames(): (string | symbol)[];
+    /**
+     * Get all listener functions registered for an event.
+     * @param {string | symbol} event - Event name.
+     * @returns {EventListener[]} List of listener callbacks.
+     */
+    listeners(event: string | symbol): EventListener[];
+    /**
+     * Get the number of listeners registered for an event.
+     * @param {string | symbol} event - Event name.
+     * @returns {number} Number of listeners.
+     */
+    listenerCount(event: string | symbol): number;
+    /**
+     * Emit an event, invoking all registered listeners
+     * with the provided arguments.
+     * @param {string | symbol} event - Event name.
+     * @param {...any} args - Arguments passed to listeners.
+     * @returns {boolean} True if the event had listeners, otherwise false.
+     */
+    emit(event: string | symbol, ...args: any[]): boolean;
+    /**
+     * Register a persistent listener for an event.
+     * @param {string | symbol} event - Event name.
+     * @param {EventListener} fn - Listener callback.
+     * @param {any} [context] - Optional execution context.
+     * @returns {EventEmitter3} The emitter instance.
+     */
+    on(event: string | symbol, fn: EventListener, context?: any): EventEmitter3;
+    /**
+     * Register a one-time listener for an event.
+     * The listener is removed after its first invocation.
+     * @param {string | symbol} event - Event name.
+     * @param {EventListener} fn - Listener callback.
+     * @param {any} [context] - Optional execution context.
+     * @returns {EventEmitter3} The emitter instance.
+     */
+    once(event: string | symbol, fn: EventListener, context?: any): EventEmitter3;
+    /**
+     * Remove a specific listener, or all listeners for an event.
+     * @param {string | symbol} event - Event name.
+     * @param {EventListener} [fn] - Listener callback to remove.
+     * @param {any} [context] - Context to match when removing.
+     * @returns {EventEmitter3} The emitter instance.
+     */
+    off(event: string | symbol, fn?: EventListener, context?: any): EventEmitter3;
+    /**
+     * Remove all listeners from the emitter,
+     * or all listeners for a specific event.
+     * @param {string | symbol} [event] - Optional event name.
+     * @returns {EventEmitter3} The emitter instance.
+     */
+    removeAllListeners(event?: string | symbol): EventEmitter3;
+    #private;
+}
+/**
+ * A function invoked when an event is emitted.
+ */
+export type EventListener = (...args: any[]) => void;
+//# sourceMappingURL=event_emitter.d.ts.map

package/types/util/event_emitter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event_emitter.d.ts","sourceRoot":"","sources":["../../src/util/event_emitter.js"],"names":[],"mappings":"AA8BA;;;GAGG;AACH;IAWE;;;OAGG;IACH,cAFa,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAI/B;IAED;;;;OAIG;IACH,iBAHW,MAAM,GAAG,MAAM,GACb,aAAa,EAAE,CAK3B;IAED;;;;OAIG;IACH,qBAHW,MAAM,GAAG,MAAM,GACb,MAAM,CAKlB;IAED;;;;;;OAMG;IACH,YAJW,MAAM,GAAG,MAAM,WACZ,GAAG,EAAA,GACJ,OAAO,CAkBnB;IA2BD;;;;;;OAMG;IACH,UALW,MAAM,GAAG,MAAM,MACf,aAAa,YACb,GAAG,GACD,aAAa,CAIzB;IAED;;;;;;;OAOG;IACH,YALW,MAAM,GAAG,MAAM,MACf,aAAa,YACb,GAAG,GACD,aAAa,CAIzB;IAED;;;;;;OAMG;IACH,WALW,MAAM,GAAG,MAAM,OACf,aAAa,YACb,GAAG,GACD,aAAa,CA6BzB;IAED;;;;;OAKG;IACH,2BAHW,MAAM,GAAG,MAAM,GACb,aAAa,CAUzB;;CACF;;;;sCAlMa,GAAG,EAAA,KACJ,IAAI"}

package/types/util/fetch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../src/util/fetch.js"],"names":[],"mappings":"AAcA,yBAA0B,CAAC,CAAC;AAE5B;IACE;;;;;;OAMG;IACH,qBALW,MAAM,YACN,MAAM,GAAG,GAAG,GAAG,OAAO,gBACtB,WAAW,YACX,QAAQ,EASlB;IAJC,iCAAwB;IACxB,0BAAgC;IAChC,mBAAwB;IACxB,cAAqC;CAExC;AASM,qCALI,MAAM,GAAG,GAAG,GAAG,OAAO,gBACtB,WAAW,iBACX;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAC,GAC9E,OAAO,CAAC,QAAQ,CAAC,CAkD7B"}
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../src/util/fetch.js"],"names":[],"mappings":"AAcA,yBAA0B,CAAC,CAAC;AAE5B;IACE;;;;;;OAMG;IACH,qBALW,MAAM,YACN,MAAM,GAAG,GAAG,GAAG,OAAO,gBACtB,WAAW,YACX,QAAQ,EASlB;IAJC,iCAAwB;IACxB,0BAAgC;IAChC,mBAAwB;IACxB,cAAqC;CAExC;AASM,qCALI,MAAM,GAAG,GAAG,GAAG,OAAO,gBACtB,WAAW,iBACX;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAC,GAC9E,OAAO,CAAC,QAAQ,CAAC,CAmD7B"}

package/types/util/object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../src/util/object.js"],"names":[],"mappings":"AAMO,oCAFI,MAAM,QAUhB;AAQM,kCAJI,MAAM,UACN,MAAM,GACJ,MAAM,CAwBlB;AAQM,wCAJI,MAAM,EAAE,QACR,MAAM,GACJ,MAAM,CAEgG;AAO5G,uCAJI,MAAM,QACN,MAAM,GACJ,MAAM,GAAG,IAAI,CAezB;AASM,uCALI,MAAM,QACN,MAAM,SACN,MAAM,GAAG,IAAI,GAAG,SAAS,QAqBnC"}
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../src/util/object.js"],"names":[],"mappings":"AAMO,oCAFI,MAAM,QAShB;AAQM,kCAJI,MAAM,UACN,MAAM,GACJ,MAAM,CAwBlB;AAQM,wCAJI,MAAM,EAAE,QACR,MAAM,GACJ,MAAM,CAEgG;AAQ5G,uCAJI,MAAM,QACN,MAAM,GACJ,MAAM,GAAG,IAAI,CAezB;AASM,uCALI,MAAM,QACN,MAAM,SACN,MAAM,GAAG,IAAI,GAAG,SAAS,QAqBnC"}