@vanillaspa/event-bus 1.0.0

package/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

package/README.md

@@ -0,0 +1,48 @@
+## Getting started
+
+To install the event-bus into your project, simply run
+
+```bash
+npm install @vanillaspa/event-bus
+```
+
+## How-To
+
+Now integrate the event-bus into your app: 
+
+```javascript
+<script type="module">
+  import * as eventbus from '@vanillaspa/event-bus';
+  window.eventbus = eventbus;
+</script>
+```
+
+This is only a recommendation. You can use it however you like. With the `eventbus` object attached to the `window` object, you have access to the event-bus in your WebComponents.
+
+Then simply use `eventbus.addEventListener(type, listener)` and `eventbus.dispatchEvent(event)` in your WebComponents.
+
+You are not bound to event bubbling or capturing, which are the standard event propagation mechanisms, but now you can send events even among any objects!
+
+```javascript
+eventbus.addEventListener("click", () => {console.log("click")}, window);
+eventbus.dispatchEvent(new Event("click"), window);
+```
+
+## EventBus API architecture
+
+![EventBus schema](eventbus.png)
+
+```mermaid
+classDiagram
+    EventTarget <|-- EventBus
+    EventTarget: +addEventListener()
+    EventTarget: +removeEventListener()
+    EventTarget: +dispatchEvent()
+    EventBus: -WeakMap listeners
+```
+
+That's it. Check it out! KISS
+
+## Contribute
+
+Please give your warm feedback.

package/index.js

@@ -0,0 +1,54 @@
+export const name = "eventbus"; // The module name, can be made globally available via the window object, which should be on top.
+const listeners = new WeakMap(); // WeakMap to store listeners per object. Keep it private unless you know what you do.
+// Should auto-cleanup listeners when object is GC'd
+// This module implements EventTarget.
+export function addEventListener(type, listener, context = undefined) { // (TODO check integration into options)
+    if (context && typeof context === 'object') { // context is well defined, should be a WebComponent
+        if (!listeners.has(context)) { // context is yet unknown to the listeners
+            listeners.set(context, new Map()); // will be stored here
+        }
+        const contextListeners = listeners.get(context);
+        if (!contextListeners.has(type)) { // type is not yet registered
+            contextListeners.set(type, []);
+        } // next push the handler to the WeakMap for the given context
+        contextListeners.get(type).push(listener);
+    } else { // default
+        if (context) { // illegal context
+            throw new Error("Syntax error.");
+        }
+        window.addEventListener(type, listener);
+    }
+}
+
+export function removeEventListener(type, listener, context = undefined) {
+    if (context && typeof context === 'object') {
+        const contextListeners = listeners.get(context);
+        if (contextListeners && contextListeners.has(type)) {
+            const handlers = contextListeners.get(type);
+            const index = handlers.indexOf(listener);
+            if (index > -1) {
+                handlers.splice(index, 1);
+            }
+        }
+    } else { // default
+        window.removeEventListener(type);
+    }
+}
+
+export function dispatchEvent(event, context = undefined) {
+    if (!context) {
+        if (event instanceof CustomEvent) {
+            context = event.detail.target;
+        } else {
+            context = event.target;
+        }
+    }
+    if (context && listeners.has(context)) {
+        const contextListeners = listeners.get(context);
+        if (contextListeners.has(event.type)) { // Call context-specific listeners
+            contextListeners.get(event.type).forEach(handler => handler(event));
+        }
+    } else { // default
+        window.dispatchEvent(event);
+    }
+}

package/package.json

@@ -0,0 +1,27 @@
+{
+    "author": "Robert Meissner <rome@live.com>",
+    "bugs": {
+        "url": "https://github.com/vanillaspa/event-bus/issues"
+    },
+    "description": "An Event Bus written in <50 LOC vanilla JS. You can use it with standard WebComponents.",
+    "homepage": "https://github.com/vanillaspa/event-bus#readme",
+    "keywords": [
+        "EventBus",
+        "JavaScript",
+        "Module",
+        "Vanilla",
+        "SPA"
+    ],
+    "license": "Unlicense",
+    "main": "index.js",
+    "name": "@vanillaspa/event-bus",
+    "publishConfig": {
+        "access": "public"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/vanillaspa/event-bus.git"
+    },
+    "type": "module",
+    "version": "1.0.0"
+}