@d1g1tal/subscribr 1.0.0 → 3.0.0

package/README.md

@@ -1,2 +1,61 @@
 # subscribr
 JavaScript Publish/Subscribe
+
+This simple class enables you to subscribe and publish events using the Observer pattern.
+
+Basically, you subscribe your event handler using the `Subscribr` instance and are returned a `Subscription` instance.
+
+When the event is published, your event handler will be called.
+
+### Installation:
+```bash
+npm install @d1g1tal/subscribr --save
+```
+Or Script tags from downloaded script or from a NPM CDN like jsDelivr
+
+```html
+<!-- Load as global script -->
+<script src="/app/js/subscribr.min.js"></script>
+
+<!-- Load from CDN -->
+<script src="https://cdn.jsdelivr.net/npm/@d1g1tal/subscribr@2/dist/browser/subscribr.min.js"></script>
+```
+
+### Usage:
+```javascript
+// ES Module
+import Subscribr from '@d1g1tal/subscribr';
+
+const subscribr = new Subscribr();
+const eventName = 'myEvent';
+
+// Subscribr.prototype.subscribe returns a Subscription object.
+const mySubscription = subscribr.subscribe(eventName, (event, data) => console.log(`Event: '${event.type}' published with data: ${data}`));
+
+// Publish the event with just the name and a CustomEvent will be created with the eventName. All handlers that have subscribed are called
+subscribr.publish(eventName, { foo: 'bar', zip: 'fizz' }); // Event: 'myEvent' published with data: { foo: 'bar', zip: 'fizz' }
+
+// Is the event subscribed?
+const isSubscribed = subscribr.isSubscribed(mySubscription); // true
+
+const isUnsubscribed = subscribr.unsubscribe(mySubscription); // true
+
+const isSubscribed = subscribr.isSubscribed(mySubscription); // false
+
+
+// Subscribe to a DOM event
+const eventTargetSubscription = subsribr.subscribe('eventTargetChanged', (event, data) => console.log(`Event target changed with data: ${data}`));
+
+// Add some event to an event target (DOMElement)
+new EventTarget().addEventListener('change', function(event) {
+	// Publish the event and all handlers that have subscribed are called
+	subscribr.publish('eventTargetChanged', event, { value: this.value }); // Event target changed with data: {value: 'new value'}
+});
+
+// Is the event subscribed?
+const isSubscribed = subscribr.isSubscribed(eventTargetSubscription); // true
+
+const isUnsubscribed = subscribr.unsubscribe(eventTargetSubscription); // true
+
+const isSubscribed = subscribr.isSubscribed(eventTargetSubscription); // false
+```

package/dist/browser/subscribr.js

@@ -0,0 +1,106 @@
+var Subscribr = (() => {
+  var __defProp = Object.defineProperty;
+  var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+  var __getOwnPropNames = Object.getOwnPropertyNames;
+  var __hasOwnProp = Object.prototype.hasOwnProperty;
+  var __export = (target, all) => {
+    for (var name in all)
+      __defProp(target, name, { get: all[name], enumerable: true });
+  };
+  var __copyProps = (to, from, except, desc) => {
+    if (from && typeof from === "object" || typeof from === "function") {
+      for (let key of __getOwnPropNames(from))
+        if (!__hasOwnProp.call(to, key) && key !== except)
+          __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+    }
+    return to;
+  };
+  var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+  // src/subscribr.js
+  var subscribr_exports = {};
+  __export(subscribr_exports, {
+    default: () => Subscribr
+  });
+
+  // node_modules/@d1g1tal/collections/src/set-multi-map.js
+  var SetMultiMap = class extends Map {
+    set(key, value) {
+      super.set(key, (super.get(key) ?? /* @__PURE__ */ new Set()).add(value));
+      return this;
+    }
+    [Symbol.toStringTag]() {
+      return "SetMultiMap";
+    }
+  };
+
+  // src/context-event-handler.js
+  var ContextEventHandler = class {
+    #context;
+    #eventHandler;
+    constructor(context, eventHandler) {
+      this.#context = context;
+      this.#eventHandler = eventHandler;
+    }
+    handle(event, data) {
+      this.#eventHandler.call(this.#context, event, data);
+    }
+    get [Symbol.toStringTag]() {
+      return "ContextEventHandler";
+    }
+  };
+
+  // src/subscription.js
+  var Subscription = class {
+    #eventName;
+    #contextEventHandler;
+    constructor(eventName, contextEventHandler) {
+      this.#eventName = eventName;
+      this.#contextEventHandler = contextEventHandler;
+    }
+    get eventName() {
+      return this.#eventName;
+    }
+    get contextEventHandler() {
+      return this.#contextEventHandler;
+    }
+    get [Symbol.toStringTag]() {
+      return "Subscription";
+    }
+  };
+
+  // src/subscribr.js
+  var Subscribr = class {
+    #subscribers;
+    constructor() {
+      this.#subscribers = new SetMultiMap();
+    }
+    subscribe(eventName, eventHandler, context = eventHandler) {
+      const contextEventHandler = new ContextEventHandler(context, eventHandler);
+      this.#subscribers.set(eventName, contextEventHandler);
+      return new Subscription(eventName, contextEventHandler);
+    }
+    unsubscribe({ eventName, contextEventHandler }) {
+      const contextEventHandlers = this.#subscribers.get(eventName);
+      const removed = contextEventHandlers?.delete(contextEventHandler);
+      if (removed && contextEventHandlers.size == 0) {
+        this.#subscribers.delete(eventName);
+      }
+      return removed;
+    }
+    publish(eventName, event = new CustomEvent(eventName), data) {
+      if (data == null && !(event instanceof Event)) {
+        [data, event] = [event, new CustomEvent(eventName)];
+      }
+      this.#subscribers.get(eventName)?.forEach((contextEventHandler) => contextEventHandler.handle(event, data));
+    }
+    isSubscribed({ eventName, contextEventHandler }) {
+      return this.#subscribers.get(eventName)?.has(contextEventHandler);
+    }
+    get [Symbol.toStringTag]() {
+      return "Subscribr";
+    }
+  };
+  return __toCommonJS(subscribr_exports);
+})();
+window.Subscribr = Subscribr.default;

package/dist/browser/subscribr.min.js

@@ -0,0 +1,3 @@
+var Subscribr=(()=>{var c=Object.defineProperty;var a=Object.getOwnPropertyDescriptor;var h=Object.getOwnPropertyNames;var g=Object.prototype.hasOwnProperty;var d=(s,t)=>{for(var e in t)c(s,e,{get:t[e],enumerable:!0})},b=(s,t,e,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let r of h(t))!g.call(s,r)&&r!==e&&c(s,r,{get:()=>t[r],enumerable:!(n=a(t,r))||n.enumerable});return s};var p=s=>b(c({},"__esModule",{value:!0}),s);var S={};d(S,{default:()=>l});var o=class extends Map{set(t,e){return super.set(t,(super.get(t)??new Set).add(e)),this}[Symbol.toStringTag](){return"SetMultiMap"}};var i=class{#t;#e;constructor(t,e){this.#t=t,this.#e=e}handle(t,e){this.#e.call(this.#t,t,e)}get[Symbol.toStringTag](){return"ContextEventHandler"}};var u=class{#t;#e;constructor(t,e){this.#t=t,this.#e=e}get eventName(){return this.#t}get contextEventHandler(){return this.#e}get[Symbol.toStringTag](){return"Subscription"}};var l=class{#t;constructor(){this.#t=new o}subscribe(t,e,n=e){let r=new i(n,e);return this.#t.set(t,r),new u(t,r)}unsubscribe({eventName:t,contextEventHandler:e}){let n=this.#t.get(t),r=n?.delete(e);return r&&n.size==0&&this.#t.delete(t),r}publish(t,e=new CustomEvent(t),n){n==null&&!(e instanceof Event)&&([n,e]=[e,new CustomEvent(t)]),this.#t.get(t)?.forEach(r=>r.handle(e,n))}isSubscribed({eventName:t,contextEventHandler:e}){return this.#t.get(t)?.has(e)}get[Symbol.toStringTag](){return"Subscribr"}};return p(S);})();
+window.Subscribr = Subscribr.default;
+//# sourceMappingURL=subscribr.min.js.map

package/dist/browser/subscribr.min.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/subscribr.js", "../../node_modules/@d1g1tal/collections/src/set-multi-map.js", "../../src/context-event-handler.js", "../../src/subscription.js"],
+  "sourcesContent": ["import SetMultiMap from '@d1g1tal/collections/set-multi-map.js';\nimport ContextEventHandler from './context-event-handler.js';\nimport Subscription from './subscription.js';\n\nexport default class Subscribr {\n\t/** @type {SetMultiMap<string, ContextEventHandler>} */\n\t#subscribers;\n\n\tconstructor() {\n\t\tthis.#subscribers = new SetMultiMap();\n\t}\n\n\t/**\n\t * Subscribe to an event\n\t *\n\t * @param {string} eventName The event name to subscribe to.\n\t * @param {function(Event, *): void} eventHandler The event handler to call when the event is published.\n\t * @param {*} [context] The context to bind to the event handler.\n\t * @returns {Subscription} An object used to check if the subscription still exists and to unsubscribe from the event.\n\t */\n\tsubscribe(eventName, eventHandler, context = eventHandler) {\n\t\tconst contextEventHandler = new ContextEventHandler(context, eventHandler);\n\t\tthis.#subscribers.set(eventName, contextEventHandler);\n\n\t\treturn new Subscription(eventName, contextEventHandler);\n\t}\n\n\t/**\n\t * Unsubscribe from the event\n\t *\n\t * @param {Subscription} subscription The subscription to unsubscribe.\n\t * @param {string} subscription.eventName The event name to subscribe to.\n\t * @param {ContextEventHandler} subscription.contextEventHandler The event handler to call when the event is published.\n\t * @returns {boolean} true if eventListener has been removed successfully. false if the value is not found or if the value is not an object.\n\t */\n\tunsubscribe({ eventName, contextEventHandler }) {\n\t\tconst contextEventHandlers = this.#subscribers.get(eventName);\n\t\tconst removed = contextEventHandlers?.delete(contextEventHandler);\n\n\t\tif (removed && contextEventHandlers.size == 0) {\n\t\t\tthis.#subscribers.delete(eventName);\n\t\t}\n\n\t\treturn removed;\n\t}\n\n\t/**\n\t * Publish an event\n\t *\n\t * @param {string} eventName The name of the event.\n\t * @param {Event} event The event to be handled.\n\t * @param {*} [data] The value to be passed to the event handler as a parameter.\n\t */\n\tpublish(eventName, event = new CustomEvent(eventName), data) {\n\t\tif (data == null && !(event instanceof Event)) {\n\t\t\t[data, event] = [event, new CustomEvent(eventName)];\n\t\t}\n\t\tthis.#subscribers.get(eventName)?.forEach((contextEventHandler) => contextEventHandler.handle(event, data));\n\t}\n\n\t/**\n\t * Check if the event and handler are subscribed.\n\t *\n\t * @param {Subscription} subscription The subscription object.\n\t * @param {string} subscription.eventName The name of the event to check.\n\t * @param {ContextEventHandler} subscription.contextEventHandler The event handler to check.\n\t * @returns {boolean} true if the event name and handler are subscribed, false otherwise.\n\t */\n\tisSubscribed({ eventName, contextEventHandler }) {\n\t\treturn this.#subscribers.get(eventName)?.has(contextEventHandler);\n\t}\n\n\tget [Symbol.toStringTag]() {\n\t\treturn 'Subscribr';\n\t}\n}", "/**\n *\n * @typedef {Map<*, *>} SetMultiMap\n * @extends Map\n */\nexport default class SetMultiMap extends Map {\n\t/**\n\t * Adds a new element with a specified key and value to the SetMultiMap. If an element with the same key already exists, the value will be added to the underlying {@link Set}.\n\t *\n\t * @param {*} key The key to set.\n\t * @param {*} value The value to add to the SetMultiMap\n\t * @returns {SetMultiMap} The SetMultiMap with the updated key and value.\n\t */\n\tset(key, value) {\n\t\tsuper.set(key, (super.get(key) ?? new Set()).add(value));\n\n\t\treturn this;\n\t}\n\n\t[Symbol.toStringTag]() {\n\t\treturn 'SetMultiMap';\n\t}\n}", "export default class ContextEventHandler {\n\t#context;\n\t#eventHandler;\n\n\t/**\n\t * @param {*} context The context to bind to the event handler.\n\t * @param {function(*): void} eventHandler The event handler to call when the event is published.\n\t */\n\tconstructor(context, eventHandler) {\n\t\tthis.#context = context;\n\t\tthis.#eventHandler = eventHandler;\n\t}\n\n\t/**\n\t * Call the event handler for the provided event.\n\t *\n\t * @param {Event} event The event to handle\n\t * @param {*} [data] The value to be passed to the event handler as a parameter.\n\t */\n\thandle(event, data) {\n\t\tthis.#eventHandler.call(this.#context, event, data);\n\t}\n\n\tget [Symbol.toStringTag]() {\n\t\treturn 'ContextEventHandler';\n\t}\n}", "// eslint-disable-next-line jsdoc/valid-types\n/** @typedef {import('./context-event-handler.js').default} ContextEventHandler */\n\nexport default class Subscription {\n\t#eventName;\n\t#contextEventHandler;\n\n\t/**\n\t * @param {string} eventName The event name.\n\t * @param {ContextEventHandler} contextEventHandler Then context event handler.\n\t */\n\tconstructor(eventName, contextEventHandler) {\n\t\tthis.#eventName = eventName;\n\t\tthis.#contextEventHandler = contextEventHandler;\n\t}\n\n\t/**\n\t * Gets the event name for the subscription.\n\t *\n\t * @returns {string} The event name.\n\t */\n\tget eventName() {\n\t\treturn this.#eventName;\n\t}\n\n\t/**\n\t * Gets the context event handler.\n\t *\n\t * @returns {ContextEventHandler} The context event handler\n\t */\n\tget contextEventHandler() {\n\t\treturn this.#contextEventHandler;\n\t}\n\n\tget [Symbol.toStringTag]() {\n\t\treturn 'Subscription';\n\t}\n}"],
+  "mappings": "gbAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,aAAAE,ICKA,IAAqBC,EAArB,cAAyC,GAAI,CAQ5C,IAAIC,EAAKC,EAAO,CACf,aAAM,IAAID,GAAM,MAAM,IAAIA,CAAG,GAAK,IAAI,KAAO,IAAIC,CAAK,CAAC,EAEhD,IACR,CAEA,CAAC,OAAO,cAAe,CACtB,MAAO,aACR,CACD,ECtBA,IAAqBC,EAArB,KAAyC,CACxCC,GACAC,GAMA,YAAYC,EAASC,EAAc,CAClC,KAAKH,GAAWE,EAChB,KAAKD,GAAgBE,CACtB,CAQA,OAAOC,EAAOC,EAAM,CACnB,KAAKJ,GAAc,KAAK,KAAKD,GAAUI,EAAOC,CAAI,CACnD,CAEA,IAAK,OAAO,cAAe,CAC1B,MAAO,qBACR,CACD,ECvBA,IAAqBC,EAArB,KAAkC,CACjCC,GACAC,GAMA,YAAYC,EAAWC,EAAqB,CAC3C,KAAKH,GAAaE,EAClB,KAAKD,GAAuBE,CAC7B,CAOA,IAAI,WAAY,CACf,OAAO,KAAKH,EACb,CAOA,IAAI,qBAAsB,CACzB,OAAO,KAAKC,EACb,CAEA,IAAK,OAAO,cAAe,CAC1B,MAAO,cACR,CACD,EHjCA,IAAqBG,EAArB,KAA+B,CAE9BC,GAEA,aAAc,CACb,KAAKA,GAAe,IAAIC,CACzB,CAUA,UAAUC,EAAWC,EAAcC,EAAUD,EAAc,CAC1D,IAAME,EAAsB,IAAIC,EAAoBF,EAASD,CAAY,EACzE,YAAKH,GAAa,IAAIE,EAAWG,CAAmB,EAE7C,IAAIE,EAAaL,EAAWG,CAAmB,CACvD,CAUA,YAAY,CAAE,UAAAH,EAAW,oBAAAG,CAAoB,EAAG,CAC/C,IAAMG,EAAuB,KAAKR,GAAa,IAAIE,CAAS,EACtDO,EAAUD,GAAsB,OAAOH,CAAmB,EAEhE,OAAII,GAAWD,EAAqB,MAAQ,GAC3C,KAAKR,GAAa,OAAOE,CAAS,EAG5BO,CACR,CASA,QAAQP,EAAWQ,EAAQ,IAAI,YAAYR,CAAS,EAAGS,EAAM,CACxDA,GAAQ,MAAQ,EAAED,aAAiB,SACtC,CAACC,EAAMD,CAAK,EAAI,CAACA,EAAO,IAAI,YAAYR,CAAS,CAAC,GAEnD,KAAKF,GAAa,IAAIE,CAAS,GAAG,QAASG,GAAwBA,EAAoB,OAAOK,EAAOC,CAAI,CAAC,CAC3G,CAUA,aAAa,CAAE,UAAAT,EAAW,oBAAAG,CAAoB,EAAG,CAChD,OAAO,KAAKL,GAAa,IAAIE,CAAS,GAAG,IAAIG,CAAmB,CACjE,CAEA,IAAK,OAAO,cAAe,CAC1B,MAAO,WACR,CACD",
+  "names": ["subscribr_exports", "__export", "Subscribr", "SetMultiMap", "key", "value", "ContextEventHandler", "#context", "#eventHandler", "context", "eventHandler", "event", "data", "Subscription", "#eventName", "#contextEventHandler", "eventName", "contextEventHandler", "Subscribr", "#subscribers", "SetMultiMap", "eventName", "eventHandler", "context", "contextEventHandler", "ContextEventHandler", "Subscription", "contextEventHandlers", "removed", "event", "data"]
+}

package/dist/esm/subscribr.js

@@ -0,0 +1,81 @@
+// node_modules/@d1g1tal/collections/src/set-multi-map.js
+var SetMultiMap = class extends Map {
+  set(key, value) {
+    super.set(key, (super.get(key) ?? /* @__PURE__ */ new Set()).add(value));
+    return this;
+  }
+  [Symbol.toStringTag]() {
+    return "SetMultiMap";
+  }
+};
+
+// src/context-event-handler.js
+var ContextEventHandler = class {
+  #context;
+  #eventHandler;
+  constructor(context, eventHandler) {
+    this.#context = context;
+    this.#eventHandler = eventHandler;
+  }
+  handle(event, data) {
+    this.#eventHandler.call(this.#context, event, data);
+  }
+  get [Symbol.toStringTag]() {
+    return "ContextEventHandler";
+  }
+};
+
+// src/subscription.js
+var Subscription = class {
+  #eventName;
+  #contextEventHandler;
+  constructor(eventName, contextEventHandler) {
+    this.#eventName = eventName;
+    this.#contextEventHandler = contextEventHandler;
+  }
+  get eventName() {
+    return this.#eventName;
+  }
+  get contextEventHandler() {
+    return this.#contextEventHandler;
+  }
+  get [Symbol.toStringTag]() {
+    return "Subscription";
+  }
+};
+
+// src/subscribr.js
+var Subscribr = class {
+  #subscribers;
+  constructor() {
+    this.#subscribers = new SetMultiMap();
+  }
+  subscribe(eventName, eventHandler, context = eventHandler) {
+    const contextEventHandler = new ContextEventHandler(context, eventHandler);
+    this.#subscribers.set(eventName, contextEventHandler);
+    return new Subscription(eventName, contextEventHandler);
+  }
+  unsubscribe({ eventName, contextEventHandler }) {
+    const contextEventHandlers = this.#subscribers.get(eventName);
+    const removed = contextEventHandlers?.delete(contextEventHandler);
+    if (removed && contextEventHandlers.size == 0) {
+      this.#subscribers.delete(eventName);
+    }
+    return removed;
+  }
+  publish(eventName, event = new CustomEvent(eventName), data) {
+    if (data == null && !(event instanceof Event)) {
+      [data, event] = [event, new CustomEvent(eventName)];
+    }
+    this.#subscribers.get(eventName)?.forEach((contextEventHandler) => contextEventHandler.handle(event, data));
+  }
+  isSubscribed({ eventName, contextEventHandler }) {
+    return this.#subscribers.get(eventName)?.has(contextEventHandler);
+  }
+  get [Symbol.toStringTag]() {
+    return "Subscribr";
+  }
+};
+export {
+  Subscribr as default
+};

package/dist/esm/subscribr.min.js

@@ -0,0 +1,2 @@
+var n=class extends Map{set(t,e){return super.set(t,(super.get(t)??new Set).add(e)),this}[Symbol.toStringTag](){return"SetMultiMap"}};var o=class{#t;#e;constructor(t,e){this.#t=t,this.#e=e}handle(t,e){this.#e.call(this.#t,t,e)}get[Symbol.toStringTag](){return"ContextEventHandler"}};var i=class{#t;#e;constructor(t,e){this.#t=t,this.#e=e}get eventName(){return this.#t}get contextEventHandler(){return this.#e}get[Symbol.toStringTag](){return"Subscription"}};var l=class{#t;constructor(){this.#t=new n}subscribe(t,e,r=e){let s=new o(r,e);return this.#t.set(t,s),new i(t,s)}unsubscribe({eventName:t,contextEventHandler:e}){let r=this.#t.get(t),s=r?.delete(e);return s&&r.size==0&&this.#t.delete(t),s}publish(t,e=new CustomEvent(t),r){r==null&&!(e instanceof Event)&&([r,e]=[e,new CustomEvent(t)]),this.#t.get(t)?.forEach(s=>s.handle(e,r))}isSubscribed({eventName:t,contextEventHandler:e}){return this.#t.get(t)?.has(e)}get[Symbol.toStringTag](){return"Subscribr"}};export{l as default};
+//# sourceMappingURL=subscribr.min.js.map

package/dist/esm/subscribr.min.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../node_modules/@d1g1tal/collections/src/set-multi-map.js", "../../src/context-event-handler.js", "../../src/subscription.js", "../../src/subscribr.js"],
+  "sourcesContent": ["/**\n *\n * @typedef {Map<*, *>} SetMultiMap\n * @extends Map\n */\nexport default class SetMultiMap extends Map {\n\t/**\n\t * Adds a new element with a specified key and value to the SetMultiMap. If an element with the same key already exists, the value will be added to the underlying {@link Set}.\n\t *\n\t * @param {*} key The key to set.\n\t * @param {*} value The value to add to the SetMultiMap\n\t * @returns {SetMultiMap} The SetMultiMap with the updated key and value.\n\t */\n\tset(key, value) {\n\t\tsuper.set(key, (super.get(key) ?? new Set()).add(value));\n\n\t\treturn this;\n\t}\n\n\t[Symbol.toStringTag]() {\n\t\treturn 'SetMultiMap';\n\t}\n}", "export default class ContextEventHandler {\n\t#context;\n\t#eventHandler;\n\n\t/**\n\t * @param {*} context The context to bind to the event handler.\n\t * @param {function(*): void} eventHandler The event handler to call when the event is published.\n\t */\n\tconstructor(context, eventHandler) {\n\t\tthis.#context = context;\n\t\tthis.#eventHandler = eventHandler;\n\t}\n\n\t/**\n\t * Call the event handler for the provided event.\n\t *\n\t * @param {Event} event The event to handle\n\t * @param {*} [data] The value to be passed to the event handler as a parameter.\n\t */\n\thandle(event, data) {\n\t\tthis.#eventHandler.call(this.#context, event, data);\n\t}\n\n\tget [Symbol.toStringTag]() {\n\t\treturn 'ContextEventHandler';\n\t}\n}", "// eslint-disable-next-line jsdoc/valid-types\n/** @typedef {import('./context-event-handler.js').default} ContextEventHandler */\n\nexport default class Subscription {\n\t#eventName;\n\t#contextEventHandler;\n\n\t/**\n\t * @param {string} eventName The event name.\n\t * @param {ContextEventHandler} contextEventHandler Then context event handler.\n\t */\n\tconstructor(eventName, contextEventHandler) {\n\t\tthis.#eventName = eventName;\n\t\tthis.#contextEventHandler = contextEventHandler;\n\t}\n\n\t/**\n\t * Gets the event name for the subscription.\n\t *\n\t * @returns {string} The event name.\n\t */\n\tget eventName() {\n\t\treturn this.#eventName;\n\t}\n\n\t/**\n\t * Gets the context event handler.\n\t *\n\t * @returns {ContextEventHandler} The context event handler\n\t */\n\tget contextEventHandler() {\n\t\treturn this.#contextEventHandler;\n\t}\n\n\tget [Symbol.toStringTag]() {\n\t\treturn 'Subscription';\n\t}\n}", "import SetMultiMap from '@d1g1tal/collections/set-multi-map.js';\nimport ContextEventHandler from './context-event-handler.js';\nimport Subscription from './subscription.js';\n\nexport default class Subscribr {\n\t/** @type {SetMultiMap<string, ContextEventHandler>} */\n\t#subscribers;\n\n\tconstructor() {\n\t\tthis.#subscribers = new SetMultiMap();\n\t}\n\n\t/**\n\t * Subscribe to an event\n\t *\n\t * @param {string} eventName The event name to subscribe to.\n\t * @param {function(Event, *): void} eventHandler The event handler to call when the event is published.\n\t * @param {*} [context] The context to bind to the event handler.\n\t * @returns {Subscription} An object used to check if the subscription still exists and to unsubscribe from the event.\n\t */\n\tsubscribe(eventName, eventHandler, context = eventHandler) {\n\t\tconst contextEventHandler = new ContextEventHandler(context, eventHandler);\n\t\tthis.#subscribers.set(eventName, contextEventHandler);\n\n\t\treturn new Subscription(eventName, contextEventHandler);\n\t}\n\n\t/**\n\t * Unsubscribe from the event\n\t *\n\t * @param {Subscription} subscription The subscription to unsubscribe.\n\t * @param {string} subscription.eventName The event name to subscribe to.\n\t * @param {ContextEventHandler} subscription.contextEventHandler The event handler to call when the event is published.\n\t * @returns {boolean} true if eventListener has been removed successfully. false if the value is not found or if the value is not an object.\n\t */\n\tunsubscribe({ eventName, contextEventHandler }) {\n\t\tconst contextEventHandlers = this.#subscribers.get(eventName);\n\t\tconst removed = contextEventHandlers?.delete(contextEventHandler);\n\n\t\tif (removed && contextEventHandlers.size == 0) {\n\t\t\tthis.#subscribers.delete(eventName);\n\t\t}\n\n\t\treturn removed;\n\t}\n\n\t/**\n\t * Publish an event\n\t *\n\t * @param {string} eventName The name of the event.\n\t * @param {Event} event The event to be handled.\n\t * @param {*} [data] The value to be passed to the event handler as a parameter.\n\t */\n\tpublish(eventName, event = new CustomEvent(eventName), data) {\n\t\tif (data == null && !(event instanceof Event)) {\n\t\t\t[data, event] = [event, new CustomEvent(eventName)];\n\t\t}\n\t\tthis.#subscribers.get(eventName)?.forEach((contextEventHandler) => contextEventHandler.handle(event, data));\n\t}\n\n\t/**\n\t * Check if the event and handler are subscribed.\n\t *\n\t * @param {Subscription} subscription The subscription object.\n\t * @param {string} subscription.eventName The name of the event to check.\n\t * @param {ContextEventHandler} subscription.contextEventHandler The event handler to check.\n\t * @returns {boolean} true if the event name and handler are subscribed, false otherwise.\n\t */\n\tisSubscribed({ eventName, contextEventHandler }) {\n\t\treturn this.#subscribers.get(eventName)?.has(contextEventHandler);\n\t}\n\n\tget [Symbol.toStringTag]() {\n\t\treturn 'Subscribr';\n\t}\n}"],
+  "mappings": "AAKA,IAAqBA,EAArB,cAAyC,GAAI,CAQ5C,IAAIC,EAAKC,EAAO,CACf,aAAM,IAAID,GAAM,MAAM,IAAIA,CAAG,GAAK,IAAI,KAAO,IAAIC,CAAK,CAAC,EAEhD,IACR,CAEA,CAAC,OAAO,cAAe,CACtB,MAAO,aACR,CACD,ECtBA,IAAqBC,EAArB,KAAyC,CACxCC,GACAC,GAMA,YAAYC,EAASC,EAAc,CAClC,KAAKH,GAAWE,EAChB,KAAKD,GAAgBE,CACtB,CAQA,OAAOC,EAAOC,EAAM,CACnB,KAAKJ,GAAc,KAAK,KAAKD,GAAUI,EAAOC,CAAI,CACnD,CAEA,IAAK,OAAO,cAAe,CAC1B,MAAO,qBACR,CACD,ECvBA,IAAqBC,EAArB,KAAkC,CACjCC,GACAC,GAMA,YAAYC,EAAWC,EAAqB,CAC3C,KAAKH,GAAaE,EAClB,KAAKD,GAAuBE,CAC7B,CAOA,IAAI,WAAY,CACf,OAAO,KAAKH,EACb,CAOA,IAAI,qBAAsB,CACzB,OAAO,KAAKC,EACb,CAEA,IAAK,OAAO,cAAe,CAC1B,MAAO,cACR,CACD,ECjCA,IAAqBG,EAArB,KAA+B,CAE9BC,GAEA,aAAc,CACb,KAAKA,GAAe,IAAIC,CACzB,CAUA,UAAUC,EAAWC,EAAcC,EAAUD,EAAc,CAC1D,IAAME,EAAsB,IAAIC,EAAoBF,EAASD,CAAY,EACzE,YAAKH,GAAa,IAAIE,EAAWG,CAAmB,EAE7C,IAAIE,EAAaL,EAAWG,CAAmB,CACvD,CAUA,YAAY,CAAE,UAAAH,EAAW,oBAAAG,CAAoB,EAAG,CAC/C,IAAMG,EAAuB,KAAKR,GAAa,IAAIE,CAAS,EACtDO,EAAUD,GAAsB,OAAOH,CAAmB,EAEhE,OAAII,GAAWD,EAAqB,MAAQ,GAC3C,KAAKR,GAAa,OAAOE,CAAS,EAG5BO,CACR,CASA,QAAQP,EAAWQ,EAAQ,IAAI,YAAYR,CAAS,EAAGS,EAAM,CACxDA,GAAQ,MAAQ,EAAED,aAAiB,SACtC,CAACC,EAAMD,CAAK,EAAI,CAACA,EAAO,IAAI,YAAYR,CAAS,CAAC,GAEnD,KAAKF,GAAa,IAAIE,CAAS,GAAG,QAASG,GAAwBA,EAAoB,OAAOK,EAAOC,CAAI,CAAC,CAC3G,CAUA,aAAa,CAAE,UAAAT,EAAW,oBAAAG,CAAoB,EAAG,CAChD,OAAO,KAAKL,GAAa,IAAIE,CAAS,GAAG,IAAIG,CAAmB,CACjE,CAEA,IAAK,OAAO,cAAe,CAC1B,MAAO,WACR,CACD",
+  "names": ["SetMultiMap", "key", "value", "ContextEventHandler", "#context", "#eventHandler", "context", "eventHandler", "event", "data", "Subscription", "#eventName", "#contextEventHandler", "eventName", "contextEventHandler", "Subscribr", "#subscribers", "SetMultiMap", "eventName", "eventHandler", "context", "contextEventHandler", "ContextEventHandler", "Subscription", "contextEventHandlers", "removed", "event", "data"]
+}

package/index.d.ts

@@ -0,0 +1,3 @@
+export { default as ContextEventHandler } from "./src/context-event-handler.js";
+export { default as Subscribr } from "./src/subscribr.js";
+export { default as Subscription } from "./src/subscription.js";

package/index.js

@@ -0,0 +1,3 @@
+export {default as ContextEventHandler} from './src/context-event-handler.js';
+export {default as Subscribr} from './src/subscribr.js';
+export {default as Subscription} from './src/subscription.js';

package/package.json

@@ -1,16 +1,31 @@
 {
   "name": "@d1g1tal/subscribr",
-  "version": "1.0.0",
+  "version": "3.0.0",
   "description": "JavaScript Publish/Subscribe Library",
   "type": "module",
-  "main": "./src/subscribr.js",
-	"module": "./src/subscribr.js",
-	"publishConfig": {
+  "types": "index.d.js",
+  "exports": {
+    ".": {
+      "import": "./src/subscribr.js",
+      "default": "./dist/browser/subscribr.min.js"
+    }
+  },
+  "publishConfig": {
     "access": "public"
   },
+  "files": [
+    "/src",
+    "/dist",
+    "index.js",
+    "index.d.ts"
+  ],
   "scripts": {
-    "build": "rimraf dist && esbuild src/subscribr.js --bundle --sourcemap --minify --target=es2022 --format=esm --outfile=dist/esm/subscribr.min.js && esbuild src/subscribr.js --bundle --sourcemap --minify --target=es2022 --platform=browser --global-name=Subscribr --outfile=dist/browser/subscribr.min.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "npm run build:esm && npm run build:browser",
+    "build:esm": "rimraf dist/esm && esbuild src/subscribr.js --bundle --target=es2022 --format=esm --outfile=dist/esm/subscribr.js && esbuild src/subscribr.js --bundle --sourcemap --minify --target=es2022 --format=esm --outfile=dist/esm/subscribr.min.js",
+    "build:browser": "rimraf dist/browser && esbuild src/subscribr.js --bundle --target=es2022 --platform=browser --global-name=Subscribr --footer:js='window.Subscribr = Subscribr.default;' --outfile=dist/browser/subscribr.js && esbuild src/subscribr.js --bundle --sourcemap --minify --target=es2022 --platform=browser --global-name=Subscribr --footer:js='window.Subscribr = Subscribr.default;' --outfile=dist/browser/subscribr.min.js",
+    "lint": "eslint --ext .js --fix --ignore-path .gitignore .",
+    "d.ts": "tsc --allowJs -declaration --emitDeclarationOnly  --skipLibCheck --lib esnext index.js",
+    "test": "node --no-warnings --experimental-vm-modules node_modules/jest/bin/jest.js"
   },
   "repository": {
     "type": "git",
@@ -28,8 +43,31 @@
   },
   "homepage": "https://github.com/D1g1talEntr0py/subscribr#readme",
   "devDependencies": {
-    "esbuild": "^0.15.7",
-    "eslint": "^8.23.1",
+    "@d1g1tal/chrysalis": "^1.1.7",
+    "@skypack/package-check": "^0.2.2",
+    "esbuild": "^0.15.12",
+    "eslint": "^8.26.0",
+    "eslint-plugin-compat": "^4.0.2",
+    "eslint-plugin-jsdoc": "^39.3.21",
+    "jest": "^29.2.1",
     "rimraf": "^3.0.2"
+  },
+  "jest": {
+    "verbose": true,
+    "transform": {},
+    "coverageDirectory": "./tests/coverage/",
+    "coveragePathIgnorePatterns": [
+      "/node_modules/"
+    ],
+    "collectCoverage": true,
+    "collectCoverageFrom": [
+      "src/**/*.js"
+    ]
+  },
+  "browserslist": [
+    "defaults"
+  ],
+  "dependencies": {
+    "@d1g1tal/collections": "^0.0.4"
   }
 }

package/src/context-event-handler.d.ts

@@ -0,0 +1,22 @@
+export default class ContextEventHandler {
+    /**
+     * @param {*} context The context to bind to the event handler.
+     * @param {function(*): void} eventHandler The event handler to call when the event is published.
+     */
+    constructor(context: any, eventHandler: (arg0: any) => void);
+    /**
+     * Call the event handler for the provided event.
+     *
+     * @param {Event} event The event to handle
+     * @param {*} [data] The value to be passed to the event handler as a parameter.
+     */
+    handle(event: Event, data?: any): void;
+    /**
+     * Get the event handler
+     *
+     * @returns {function(*)} The event handler
+     */
+    get eventHandler(): (arg0: any) => any;
+    get [Symbol.toStringTag](): string;
+    #private;
+}

package/src/context-event-handler.js

@@ -0,0 +1,27 @@
+export default class ContextEventHandler {
+	#context;
+	#eventHandler;
+
+	/**
+	 * @param {*} context The context to bind to the event handler.
+	 * @param {function(*): void} eventHandler The event handler to call when the event is published.
+	 */
+	constructor(context, eventHandler) {
+		this.#context = context;
+		this.#eventHandler = eventHandler;
+	}
+
+	/**
+	 * Call the event handler for the provided event.
+	 *
+	 * @param {Event} event The event to handle
+	 * @param {*} [data] The value to be passed to the event handler as a parameter.
+	 */
+	handle(event, data) {
+		this.#eventHandler.call(this.#context, event, data);
+	}
+
+	get [Symbol.toStringTag]() {
+		return 'ContextEventHandler';
+	}
+}

package/src/subscribr.d.ts

@@ -0,0 +1,40 @@
+export default class Subscribr {
+    /**
+     * Subscribe to an event
+     *
+     * @param {string} eventName The event name to subscribe to.
+     * @param {function(Event, *): void} eventHandler The event handler to call when the event is published.
+     * @param {*} [context] The context to bind to the event handler.
+     * @returns {Subscription} An object used to check if the subscription still exists and to unsubscribe from the event.
+     */
+    subscribe(eventName: string, eventHandler: (arg0: Event, arg1: any) => void, context?: any): Subscription;
+    /**
+     * Unsubscribe from the event
+     *
+     * @param {Subscription} subscription The subscription to unsubscribe.
+     * @param {string} subscription.eventName The event name to subscribe to.
+     * @param {ContextEventHandler} subscription.contextEventHandler The event handler to call when the event is published.
+     * @returns {boolean} true if eventListener has been removed successfully. false if the value is not found or if the value is not an object.
+     */
+    unsubscribe({ eventName, contextEventHandler }: Subscription): boolean;
+    /**
+     * Publish an event
+     *
+     * @param {string} eventName The name of the event.
+     * @param {Event} event The event to be handled.
+     * @param {*} [data] The value to be passed to the event handler as a parameter.
+     */
+    publish(eventName: string, event?: Event, data?: any): void;
+    /**
+     * Check if the event and handler are subscribed.
+     *
+     * @param {Subscription} subscription The subscription object.
+     * @param {string} subscription.eventName The name of the event to check.
+     * @param {ContextEventHandler} subscription.contextEventHandler The event handler to check.
+     * @returns {boolean} true if the event name and handler are subscribed, false otherwise.
+     */
+    isSubscribed({ eventName, contextEventHandler }: Subscription): boolean;
+    get [Symbol.toStringTag](): string;
+    #private;
+}
+import Subscription from "./subscription.js";

package/src/subscribr.js

@@ -1,48 +1,77 @@
+import SetMultiMap from '@d1g1tal/collections/set-multi-map.js';
+import ContextEventHandler from './context-event-handler.js';
+import Subscription from './subscription.js';
+
 export default class Subscribr {
-	/** @type {Map.<string, Array.<function(Event, Object):undefined>>} */
-  #subscribers;
+	/** @type {SetMultiMap<string, ContextEventHandler>} */
+	#subscribers;
 
-  constructor() {
-    this.#subscribers = new Map();
-  }
+	constructor() {
+		this.#subscribers = new SetMultiMap();
+	}
 
 	/**
 	 * Subscribe to an event
 	 *
-	 * @param {string} eventType
-	 * @param {function(Event, Object):undefined} eventListener
-	 * @return {{unsubscribe: function()}}
+	 * @param {string} eventName The event name to subscribe to.
+	 * @param {function(Event, *): void} eventHandler The event handler to call when the event is published.
+	 * @param {*} [context] The context to bind to the event handler.
+	 * @returns {Subscription} An object used to check if the subscription still exists and to unsubscribe from the event.
 	 */
-  subscribe(eventType, eventListener) {
-		if (!this.#subscribers.has(eventType)) {
-			this.#subscribers.set(eventType, []);
-		}
+	subscribe(eventName, eventHandler, context = eventHandler) {
+		const contextEventHandler = new ContextEventHandler(context, eventHandler);
+		this.#subscribers.set(eventName, contextEventHandler);
+
+		return new Subscription(eventName, contextEventHandler);
+	}
+
+	/**
+	 * Unsubscribe from the event
+	 *
+	 * @param {Subscription} subscription The subscription to unsubscribe.
+	 * @param {string} subscription.eventName The event name to subscribe to.
+	 * @param {ContextEventHandler} subscription.contextEventHandler The event handler to call when the event is published.
+	 * @returns {boolean} true if eventListener has been removed successfully. false if the value is not found or if the value is not an object.
+	 */
+	unsubscribe({ eventName, contextEventHandler }) {
+		const contextEventHandlers = this.#subscribers.get(eventName);
+		const removed = contextEventHandlers?.delete(contextEventHandler);
 
-		const subscribr = this;
-		const index = this.#subscribers.get(eventType).push(eventListener) - 1;
+		if (removed && contextEventHandlers.size == 0) {
+			this.#subscribers.delete(eventName);
+		}
 
-		return {
-			/**
-			 * Unsubscribe from the event
-			 */
-			unsubscribe: () => subscribr.#subscribers.get(eventType).splice(index, 1)
-		};
+		return removed;
 	}
 
 	/**
 	 * Publish an event
 	 *
-	 * @param {string} eventType
-	 * @param {Event} [event=new CustomEvent(eventType)]
-	 * @param {Object} [data]
+	 * @param {string} eventName The name of the event.
+	 * @param {Event} event The event to be handled.
+	 * @param {*} [data] The value to be passed to the event handler as a parameter.
 	 */
-	publish(eventType, event = new CustomEvent(eventType), data) {
-		if (!this.#subscribers.has(eventType)) {
-			return;
+	publish(eventName, event = new CustomEvent(eventName), data) {
+		if (data == null && !(event instanceof Event)) {
+			// Swap the event and data parameters becuase only data was passesed without an event object
+			[data, event] = [event, new CustomEvent(eventName)];
 		}
+		this.#subscribers.get(eventName)?.forEach((contextEventHandler) => contextEventHandler.handle(event, data));
+	}
+
+	/**
+	 * Check if the event and handler are subscribed.
+	 *
+	 * @param {Subscription} subscription The subscription object.
+	 * @param {string} subscription.eventName The name of the event to check.
+	 * @param {ContextEventHandler} subscription.contextEventHandler The event handler to check.
+	 * @returns {boolean} true if the event name and handler are subscribed, false otherwise.
+	 */
+	isSubscribed({ eventName, contextEventHandler }) {
+		return this.#subscribers.get(eventName)?.has(contextEventHandler);
+	}
 
-		this.#subscribers.get(eventType).forEach(function(eventListener) {
-			eventListener.call(this, event, data);
-		});
+	get [Symbol.toStringTag]() {
+		return 'Subscribr';
 	}
 }

package/src/subscription.d.ts

@@ -0,0 +1,23 @@
+/** @typedef {import('./context-event-handler.js').default} ContextEventHandler */
+export default class Subscription {
+    /**
+     * @param {string} eventName The event name.
+     * @param {ContextEventHandler} contextEventHandler Then context event handler.
+     */
+    constructor(eventName: string, contextEventHandler: ContextEventHandler);
+    /**
+     * Gets the event name for the subscription.
+     *
+     * @returns {string} The event name.
+     */
+    get eventName(): string;
+    /**
+     * Gets the context event handler.
+     *
+     * @returns {ContextEventHandler} The context event handler
+     */
+    get contextEventHandler(): import("./context-event-handler.js").default;
+    get [Symbol.toStringTag](): string;
+    #private;
+}
+export type ContextEventHandler = import('./context-event-handler.js').default;

package/src/subscription.js

@@ -0,0 +1,38 @@
+// eslint-disable-next-line jsdoc/valid-types
+/** @typedef {import('./context-event-handler.js').default} ContextEventHandler */
+
+export default class Subscription {
+	#eventName;
+	#contextEventHandler;
+
+	/**
+	 * @param {string} eventName The event name.
+	 * @param {ContextEventHandler} contextEventHandler Then context event handler.
+	 */
+	constructor(eventName, contextEventHandler) {
+		this.#eventName = eventName;
+		this.#contextEventHandler = contextEventHandler;
+	}
+
+	/**
+	 * Gets the event name for the subscription.
+	 *
+	 * @returns {string} The event name.
+	 */
+	get eventName() {
+		return this.#eventName;
+	}
+
+	/**
+	 * Gets the context event handler.
+	 *
+	 * @returns {ContextEventHandler} The context event handler
+	 */
+	get contextEventHandler() {
+		return this.#contextEventHandler;
+	}
+
+	get [Symbol.toStringTag]() {
+		return 'Subscription';
+	}
+}

package/.eslintrc.js

@@ -1,16 +0,0 @@
-export default {
-    "env": {
-        "browser": true,
-        "es2021": true,
-        "node": true
-    },
-    "extends": "eslint:recommended",
-    "overrides": [
-    ],
-    "parserOptions": {
-        "ecmaVersion": "latest",
-        "sourceType": "module"
-    },
-    "rules": {
-    }
-}

package/.vscode/settings.json

@@ -1,6 +0,0 @@
-{
-  "cSpell.words": [
-		"esbuild",
-		"Subscribr"
-	]
-}

package/jsconfig.json

@@ -1,10 +0,0 @@
-{
-    "compilerOptions": {
-      "baseUrl": ".",
-      "module": "es2020",
-      "target": "es2020",
-			"checkJs": true
-    },
-    "include": [ "./*", "src/**/*", "tests/*.js" ],
-    "exclude": [ "node_modules", "dist" ]
-  }