feat: introduce AbstractEvent and upgrade to node 20.x

Author: CMCDragonkai

.eslintrc

@@ -39,6 +39,7 @@
         "message": "Use `globalThis` instead"
       }
     ],
+    "prefer-rest-params": 0,
     "require-yield": 0,
     "eqeqeq": ["error", "smart"],
     "spaced-comment": [

package.json

@@ -47,5 +47,8 @@
     "tsconfig-paths": "^3.9.0",
     "typedoc": "^0.23.21",
     "typescript": "^4.9.3"
+  },
+  "engines": {
+    "node": ">=19.0.0"
   }
 }

pkgs.nix

@@ -1,4 +1,4 @@
 import (
-  let rev = "f294325aed382b66c7a188482101b0f336d1d7db"; in
+  let rev = "ea5234e7073d5f44728c499192544a84244bf35a"; in
   builtins.fetchTarball "https://github.com/NixOS/nixpkgs/archive/${rev}.tar.gz"
 )

shell.nix

@@ -3,7 +3,7 @@
 with pkgs;
 mkShell {
   nativeBuildInputs = [
-    nodejs
+    nodejs_20
     shellcheck
     gitAndTools.gh
   ];

src/AbstractEvent.ts

@@ -0,0 +1,50 @@
+/**
+ * By default the `detail` property of `CustomEvent` is `null`.
+ * So the default type has to be `null` too.
+ */
+class AbstractEvent<T = null> extends CustomEvent<T> {
+  protected constructorParams: IArguments;
+
+  public constructor(
+    type?: string,
+    options?: CustomEventInit<T>,
+    constructorParams?: IArguments,
+  );
+  public constructor(
+    options: CustomEventInit<T>,
+    constructorParams?: IArguments,
+  );
+  public constructor(
+    type: string | CustomEventInit<T> = new.target.name,
+    options?: CustomEventInit<T> | IArguments,
+    constructorParams?: IArguments,
+  ) {
+    if (typeof type === 'string') {
+      super(type, options as CustomEventInit<T> | undefined);
+    } else {
+      super(new.target.name, type);
+      constructorParams = options as IArguments | undefined;
+    }
+    this.constructorParams = constructorParams ?? arguments;
+  }
+
+  /**
+   * Events cannot be re-dispatched. This was probably to prevent infinite
+   * loops. So instead of re-dispatching the same instance, we re-dispatch
+   * a clone of the instance.
+   */
+  public clone(): this {
+    try {
+      return new (this.constructor as any)(...this.constructorParams);
+    } catch (e) {
+      if (e instanceof TypeError) {
+        throw new TypeError(
+          `Cloning ${this.constructor.name} requires the original constructor arguments to be passed into super`,
+        );
+      }
+      throw e;
+    }
+  }
+}
+
+export default AbstractEvent;

src/EventAny.ts

@@ -1,12 +1,11 @@
-// @ts-ignore package.json is outside rootDir
+import AbstractEvent from './AbstractEvent';
+// @ts-ignore package.json is outside root dir
 import { name } from '../package.json';
 
-class EventAny extends Event {
+class EventAny extends AbstractEvent<Event> {
   public static type = `${name}/${this.name}`;
-  public detail: Event;
-  constructor(options: EventInit & { detail: Event }) {
-    super(EventAny.type, options);
-    this.detail = options.detail;
+  public constructor(options: EventInit & { detail: Event }) {
+    super(EventAny.type, options, arguments);
   }
 }
 

src/Evented.ts

@@ -11,7 +11,6 @@ interface Evented {
     callback: EventListenerOrEventListenerObject | null,
     options?: AddEventListenerOptions | boolean,
   ): void;
-  dispatchEvent(event: Event): boolean;
   removeEventListener(
     callback: EventListenerOrEventListenerObject | null,
     options?: EventListenerOptions | boolean,
@@ -21,6 +20,7 @@ interface Evented {
     callback: EventListenerOrEventListenerObject | null,
     options?: EventListenerOptions | boolean,
   ): void;
+  dispatchEvent(event: Event): boolean;
 }
 
 function Evented() {