feat: introduce AbstractEvent and upgrade to node 20.x

[CMCDragonkai]

Description

This introduces the AbstractEvent in a similar vein to AbstractError in js-errors. It is supposed to be used as the root event class for all event related operations to help govern push-flows.

Because AbstractEvent uses CustomEvent this bumps up our nodejs to 20.x which is the next LTS, and has CustomEvent available as a global.

Notice updates to:

• .eslintrc
• pkgs.nix
• shell.nix

Any downstream packages using this will need to upgrade correspondingly.

// These all work now
new AbstractEvent();
new AbstractEvent(undefined);
new AbstractEvent(undefined, undefined);
new AbstractEvent(undefined, { detail: null });

class Event1 extends AbstractEvent<string> {}

const e1 = new Event1({ detail: 'test' });
console.log(e1.type);
console.log(e1.detail);
console.log(e1.clone());

class Event2 extends AbstractEvent<string> {
  constructor(options?: CustomEventInit<string>) {
    super(Event2.name, options, arguments);
  }
}

const e2 = new Event2({ detail: 'test' });
console.log(e2.clone());

Further instructions on utilisation will be in the README.md.

Issues Fixed

• Related Events Refactoring (integrating js-events) js-quic#53
• Related Consolidating Configuration Entropy and Nodes and Client Services Refactoring Polykey#552
• Related Integrate Observables to coordinate push-based Dataflow (with reactive properties) Polykey#444

Tasks

• 1. Added AbstractEvent
• 2. Integrate it to EventAny
• 3. Test AbstractEvent uses
• 4. Update README.md with proper utilisation

Final checklist

• Domain specific tests
• Full tests
• Updated inline-comment documentation
• Lint fixed
• Squash and rebased
• Sanity check the final build

[ghost]

👇 Click on the image for a new way to code review

Legend

[CMCDragonkai]

It is important to realise that .clone is a shallow copy of the constructor parameters. So if you pass an object as the detail initially and clone it, the detail of the new event will still point to the old object.

[CMCDragonkai]

Weird, the node 20 upgrade may have introduced the instanceof TypeError problem. Let me check.

Otherwise tests are done.

[CMCDragonkai]

So this produces false in jest:

try { new CustomEvent('abc', 'abc') } catch (e) { console.log(e instanceof TypeError); }

But it works on NodeJS. I think this is a jest error.

[CMCDragonkai]

swc-project/jest#160

[CMCDragonkai]

In the mean time we will just check the exception name which should work portably.