@whatwg-node/events 0.0.2 → 0.0.3-rc-20230419123748-0bceaec

package/CHANGELOG.md

@@ -1,13 +1,24 @@
 # @whatwg-node/events
 
+## 0.0.3-rc-20230419123748-0bceaec
+
+### Patch Changes
+
+- [#427](https://github.com/ardatan/whatwg-node/pull/427)
+  [`e8bda7c`](https://github.com/ardatan/whatwg-node/commit/e8bda7cdf440a7f4bb617ee1b5df8ee1becb4ad6)
+  Thanks [@Rugvip](https://github.com/Rugvip)! - Restructure type declarations to avoid polluting
+  global namespace.
+
 ## 0.0.2
 
 ### Patch Changes
 
-- [`c0d5c43`](https://github.com/ardatan/whatwg-node/commit/c0d5c43a1c4d3d9fcdf542472fabdebd5118fe23) Thanks [@ardatan](https://github.com/ardatan)! - Fix dispatchEvent on Node 14
+- [`c0d5c43`](https://github.com/ardatan/whatwg-node/commit/c0d5c43a1c4d3d9fcdf542472fabdebd5118fe23)
+  Thanks [@ardatan](https://github.com/ardatan)! - Fix dispatchEvent on Node 14
 
 ## 0.0.1
 
 ### Patch Changes
 
-- [`9502102`](https://github.com/ardatan/whatwg-node/commit/9502102b265945b37ee38b276ec1533fae0f308f) Thanks [@ardatan](https://github.com/ardatan)! - New Event API ponyfill
+- [`9502102`](https://github.com/ardatan/whatwg-node/commit/9502102b265945b37ee38b276ec1533fae0f308f)
+  Thanks [@ardatan](https://github.com/ardatan)! - New Event API ponyfill

package/README.md

@@ -0,0 +1,49 @@
+# `@whatwg-node/events`
+
+A ponyfill package for JavaScript [DOM Events Standard](https://dom.spec.whatwg.org/#events). If
+your JavaScript environment doesn't implement this standard natively, this package automatically
+ponyfills the missing parts, and export them as a module.
+
+## Installation
+
+```bash
+yarn add @whatwg-node/events
+```
+
+## Usage
+
+```ts
+import { Event, EventTarget } from '@whatwg-node/events'
+
+const target = new EventTarget()
+target.addEventListener('foo', (event: Event) => {
+  console.log(event.type) // foo
+})
+
+target.dispatchEvent(new Event('foo'))
+```
+
+> If your environment already implements these natively, this package will export the native ones
+> automatically.
+
+## Custom Events
+
+```ts
+import { CustomEvent, EventTarget } from '@whatwg-node/events'
+
+const target = new EventTarget()
+target.addEventListener('foo', (event: CustomEvent) => {
+  console.assert(event.detail.foo, 'bar')
+})
+
+// `detail` can take any value
+target.dispatchEvent(new CustomEvent('foo', { detail: { foo: 'bar' } }))
+```
+
+## API
+
+The following classes are exported by this package:
+
+- [Event](https://developer.mozilla.org/en-US/docs/Web/API/Event)
+- [CustomEvent](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent)
+- [EventTarget](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget)

package/dist/index.d.ts

@@ -1,11 +1,7 @@
 /// <reference lib="dom" />
 
-declare const _Event: typeof Event;
-declare const _EventTarget: typeof EventTarget;
-declare const _CustomEvent: typeof CustomEvent;
-
 declare module "@whatwg-node/events" {
-    export const Event: typeof _Event;
-    export const EventTarget: typeof _EventTarget;
-    export const CustomEvent: typeof _CustomEvent;
+    export const Event: typeof globalThis.Event;
+    export const EventTarget: typeof globalThis.EventTarget;
+    export const CustomEvent: typeof globalThis.CustomEvent;
 }

package/dist/node-ponyfill.js

@@ -1,22 +1,23 @@
 module.exports.Event = globalThis.Event;
 if (!module.exports.Event) {
-    module.exports.Event = class Event {
-        constructor(type, options) {
-            this.bubbles = !!options && !!options.bubbles;
-            this.cancelable = !!options && !!options.cancelable;
-            this.composed = !!options && !!options.composed;
-            this.type = type;
-        }
+  module.exports.Event = class Event {
+    constructor(type, options) {
+      this.bubbles = !!options && !!options.bubbles;
+      this.cancelable = !!options && !!options.cancelable;
+      this.composed = !!options && !!options.composed;
+      this.type = type;
     }
+  }
 }
 
 module.exports.EventTarget = globalThis.EventTarget;
 if (!module.exports.EventTarget) {
-    module.exports.EventTarget = class EventTarget {
-        constructor() {
-            this.__listeners = new Map();
-        }
-        addEventListener(type, listener, options) {   if (arguments.length < 2) {
+  module.exports.EventTarget = class EventTarget {
+    constructor() {
+      this.__listeners = new Map();
+    }
+    addEventListener(type, listener, options) {
+      if (arguments.length < 2) {
         throw new TypeError(
           `TypeError: Failed to execute 'addEventListener' on 'EventTarget': 2 arguments required, but only ${arguments.length} present.`
         );
@@ -31,8 +32,8 @@ if (!module.exports.EventTarget) {
         // Any given listener is only registered once
         listenersForType.set(listener, options);
       }
-        }
-        removeEventListener(type, listener, _options) {
+    }
+    removeEventListener(type, listener, _options) {
       if (arguments.length < 2) {
         throw new TypeError(
           `TypeError: Failed to execute 'addEventListener' on 'EventTarget': 2 arguments required, but only ${arguments.length} present.`
@@ -46,8 +47,8 @@ if (!module.exports.EventTarget) {
           listenersForType.delete(listener);
         }
       }
-        }
-        dispatchEvent(event) {
+    }
+    dispatchEvent(event) {
       if (!(event instanceof module.exports.Event)) {
         throw new TypeError(
           `Failed to execute 'dispatchEvent' on 'EventTarget': parameter 1 is not of type 'Event'.`
@@ -86,16 +87,16 @@ if (!module.exports.EventTarget) {
       // Since there are no cancellable events on a base EventTarget,
       // this should always return true.
       return true;
-        }
     }
+  }
 }
 
 module.exports.CustomEvent = globalThis.CustomEvent;
 if (!module.exports.CustomEvent) {
-    module.exports.CustomEvent = class CustomEvent extends module.exports.Event {
-        constructor(type, options) {
-            super(type, options);
-            this.detail = options && options.detail;
-        }
+  module.exports.CustomEvent = class CustomEvent extends module.exports.Event {
+    constructor(type, options) {
+      super(type, options);
+      this.detail = options && options.detail;
     }
+  }
 }

package/package.json

@@ -1,23 +1,24 @@
 {
   "name": "@whatwg-node/events",
-  "version": "0.0.2",
+  "version": "0.0.3-rc-20230419123748-0bceaec",
   "description": "Cross Platform Smart Event API Ponyfill",
-  "author": "Arda TANRIKULU <ardatanrikulu@gmail.com>",
   "repository": {
     "type": "git",
     "url": "ardatan/whatwg-node",
     "directory": "packages/events"
   },
+  "author": "Arda TANRIKULU <ardatanrikulu@gmail.com>",
   "license": "MIT",
-  "sideEffects": false,
   "main": "dist/node-ponyfill.js",
   "browser": "dist/global-ponyfill.js",
-  "react-native": "dist/global-ponyfill.js",
   "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "bob": false,
   "denoify": {
     "index": "dist/deno-ponyfill.ts"
   },
-  "publishConfig": {
-    "access": "public"
-  }
+  "react-native": "dist/global-ponyfill.js"
 }

package/tests/events.spec.ts

@@ -1,29 +1,29 @@
-import { EventTarget, Event, CustomEvent } from "@whatwg-node/events";
+import { CustomEvent, Event, EventTarget } from '@whatwg-node/events';
 
-describe("EventTarget", () => {
-    it('addEventListener + dispatchEvent', () => {
-        const target = new EventTarget();
-        const listener = jest.fn();
-        target.addEventListener('test', listener);
-        target.dispatchEvent(new Event('test'));
-        expect(listener).toHaveBeenCalled();
-    });
-    it('removeEventListener', () => {
-        const target = new EventTarget();
-        const listener = jest.fn();
-        target.addEventListener('test', listener);
-        target.removeEventListener('test', listener);
-        target.dispatchEvent(new Event('test'));
-        expect(listener).not.toHaveBeenCalled();
-    });
+describe('EventTarget', () => {
+  it('addEventListener + dispatchEvent', () => {
+    const target = new EventTarget();
+    const listener = jest.fn();
+    target.addEventListener('test', listener);
+    target.dispatchEvent(new Event('test'));
+    expect(listener).toHaveBeenCalled();
+  });
+  it('removeEventListener', () => {
+    const target = new EventTarget();
+    const listener = jest.fn();
+    target.addEventListener('test', listener);
+    target.removeEventListener('test', listener);
+    target.dispatchEvent(new Event('test'));
+    expect(listener).not.toHaveBeenCalled();
+  });
 });
 
 describe('CustomEvent', () => {
-    it('detail', () => {
-        const target = new EventTarget();
-        const listener = jest.fn();
-        target.addEventListener('test', listener);
-        target.dispatchEvent(new CustomEvent('test', { detail: 123 }));
-        expect(listener).toHaveBeenCalledWith(expect.objectContaining({ detail: 123 }));
-    });
-})
+  it('detail', () => {
+    const target = new EventTarget();
+    const listener = jest.fn();
+    target.addEventListener('test', listener);
+    target.dispatchEvent(new CustomEvent('test', { detail: 123 }));
+    expect(listener).toHaveBeenCalledWith(expect.objectContaining({ detail: 123 }));
+  });
+});