@creejs/commons-events 2.0.0 → 2.0.2

package/index.js

@@ -1,2 +1,2 @@
-'use strict'
-module.exports = require('./lib')
+export { default } from './lib/index.js'
+export * from './lib/index.js'

package/lib/constants.js

@@ -1,6 +1,4 @@
-'use strict'
-
-const DefaultOwner = 'DOwner$#$'
-module.exports = {
+export const DefaultOwner = 'DOwner$#$'
+export default {
   DefaultOwner
 }

package/lib/event-emitter.js

@@ -1,20 +1,22 @@
-'use strict'
 // 3rd
 // internal
-const {
-  TypeUtils: { isNil },
-  TypeAssert: {
-    assertString, assertFunction, assertNumber,
-    assertStringOrSymbol, assertNotNil
-  }
-} = require('@creejs/commons-lang')
+import { TypeUtils, TypeAssert } from '@creejs/commons-lang'
 
 // owned
-const Event = require('./event')
+import Event from './event.js'
 // eslint-disable-next-line no-unused-vars
-const Listener = require('./listener')
+import Listener from './listener.js'
 
 // module vars
+const { isNil } = TypeUtils
+const {
+  assertString, assertFunction, assertNumber,
+  assertStringOrSymbol, assertNotNil
+} = TypeAssert
+
+/**
+ * methods allowed to mixin other objects
+ */
 const MixinMethods = [
   'on', 'once', 'addListener', 'prependListener', 'prependOnceListener',
   'off', 'offAll', 'offOwner', 'removeAllListeners', 'removeListener',
@@ -29,7 +31,7 @@ let DefaultMaxListeners = 10
  *    * Operation via "owner"
  *    * Duplicate listeners are filtered out. Only unique One kept.
  */
-class EventEmitter {
+export default class EventEmitter {
   /**
    * Mixes EventEmitter methods into the given object.
    * @template T
@@ -368,4 +370,4 @@ class EventEmitter {
   }
 }
 
-module.exports = EventEmitter
+export { EventEmitter as EventEmitterType }

package/lib/event.js

@@ -1,13 +1,15 @@
-'use strict'
 // 3rd
 // internal
-const { TypeUtils: { isFunction, isNil }, TypeAssert: { assertStringOrSymbol } } = require('@creejs/commons-lang')
+import { TypeUtils, TypeAssert } from '@creejs/commons-lang'
+
+// owned
 // eslint-disable-next-line no-unused-vars
-const Listener = require('./listener')
-const { DefaultOwner } = require('./constants')
-const { assertFunction } = require('@creejs/commons-lang/lib/type-assert')
+import Listener from './listener.js'
+import { DefaultOwner } from './constants.js'
 
 // module vars
+const { isFunction, isNil } = TypeUtils
+const { assertStringOrSymbol, assertFunction } = TypeAssert
 
 /**
  * An Event definition
@@ -16,7 +18,7 @@ const { assertFunction } = require('@creejs/commons-lang/lib/type-assert')
  * 2. one listener may belong to multiple owners
  * 3. one owner may have multiple listeners
  */
-class Event {
+export default class Event {
   static get DefaultOwner () {
     return DefaultOwner
   }
@@ -357,4 +359,4 @@ class Event {
   }
 }
 
-module.exports = Event
+export { Event as EventType }

package/lib/index.js

@@ -1,7 +1,5 @@
-'use strict'
+import EventEmitter from './event-emitter.js'
 
-const EventEmitter = require('./event-emitter')
+export default EventEmitter
 
-module.exports = {
-  EventEmitter
-}
+export { EventEmitter }

package/lib/listener.js

@@ -1,17 +1,18 @@
-'use strict'
 // 3rd
 // internal
-const { TypeAssert: { assertFunction, assertNotNil } } = require('@creejs/commons-lang')
+import { TypeAssert } from '@creejs/commons-lang'
 
 // owned
-const { DefaultOwner } = require('./constants')
-// eslint-disable-next-line no-unused-vars
-const Event = require('./event')
+import { DefaultOwner } from './constants.js'
+
+// module vars
+const { assertFunction, assertNotNil } = TypeAssert
 /**
  * Wraps a function to be called when an event is fired.
+ * @typedef {import('./event.js').default} Event
  * @class Listener
  */
-class Listener {
+export default class Listener {
   /**
    * @param {Event} event
    * @param {function} callback - The function to be called when event is fired
@@ -89,5 +90,4 @@ class Listener {
     return this.invoke(...args)
   }
 }
-
-module.exports = Listener
+export { Listener as ListenerType }

package/package.json

@@ -1,30 +1,62 @@
 {
   "name": "@creejs/commons-events",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "Commons EventEmitter",
-  "main": "index.js",
+  "keywords": [
+    "commons",
+    "creejs",
+    "events",
+    "event",
+    "emitter",
+    "EventEmitter"
+  ],
   "private": false,
+  "type": "module",
   "files": [
     "index.js",
     "lib/",
     "types/",
     "README.md"
   ],
+  "types": "types/index.d.ts",
+  "main": "./dist/esm/index-min.js",
+  "exports": {
+    ".": {
+      "import": {
+        "development": "./dist/esm/index-dev.js",
+        "production": "./dist/esm/index-min.js",
+        "default": "./dist/esm/index-min.js"
+      },
+      "require": {
+        "development": "./dist/cjs/index-dev.cjs",
+        "production": "./dist/cjs/index-min.cjs",
+        "default": "./dist/cjs/index-min.cjs"
+      },
+      "browser": {
+        "development": "./dist/umd/index-dev.js",
+        "production": "./dist/umd/index-min.js",
+        "default": "./dist/cjs/index-min.js"
+      }
+    }
+  },
   "publishConfig": {
     "access": "public"
   },
-  "types": "types/index.d.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/frameworkee/commons.git"
   },
   "scripts": {
     "dts": "tsc",
-    "generate-docs": "../../node_modules/.bin/jsdoc -c ./jsdoc.json"
+    "generate-docs": "../../node_modules/.bin/jsdoc -c ./jsdoc.json",
+    "clean": "rm -rf dist && rm -rf types",
+    "build": "npm run clean && npm run dts && rollup -c",
+    "prepublishOnly": "npm run build",
+    "publish": "npm run prepublishOnly && npm publish"
   },
   "author": "rodney.vin@gmail.com",
   "license": "Apache-2.0",
   "dependencies": {
-    "@creejs/commons-lang": "^2.0.0"
+    "@creejs/commons-lang": "^2.0.1"
   }
 }

package/types/constants.d.ts

@@ -1 +1,5 @@
 export const DefaultOwner: "DOwner$#$";
+declare namespace _default {
+    export { DefaultOwner };
+}
+export default _default;

package/types/event-emitter.d.ts

@@ -1,4 +1,3 @@
-export = EventEmitter;
 /**
  * 1. An EventEmitter follows the API of NodeJS EventEmitter.
  * 2. Enhancement:
@@ -6,7 +5,7 @@ export = EventEmitter;
  *    * Operation via "owner"
  *    * Duplicate listeners are filtered out. Only unique One kept.
  */
-declare class EventEmitter {
+export default class EventEmitter {
     /**
      * Mixes EventEmitter methods into the given object.
      * @template T
@@ -14,7 +13,7 @@ declare class EventEmitter {
      * @returns {T} The modified object with EventEmitter methods.
      */
     static mixin<T>(obj: T): T;
-    static set defaultMaxListeners(maxListeners: number);
+    static set defaultMaxListeners(arg: number);
     static get defaultMaxListeners(): number;
     /**
      * @type {Map<string|Symbol, Event>}
@@ -68,7 +67,7 @@ declare class EventEmitter {
      * @param {function} [listener] - Optional specific listener to count
      * @returns {number} The number of listeners for the event
      */
-    listenerCount(eventName: string | Symbol, listener?: Function): number;
+    listenerCount(eventName: string | Symbol, listener?: Function | undefined): number;
     /**
      * Returns a copy of the array of listeners for the event named eventName.
      * 1. if a callback function added multiple times, it will be returned multiple times.
@@ -174,5 +173,6 @@ declare class EventEmitter {
      */
     hasOwner(owner: Object): boolean;
 }
-import Event = require("./event");
-import Listener = require("./listener");
+export { EventEmitter as EventEmitterType };
+import Event from "./event.js";
+import Listener from "./listener.js";

package/types/event.d.ts

@@ -1,4 +1,3 @@
-export = Event;
 /**
  * An Event definition
  * 1. listeners are grouped by owner
@@ -6,7 +5,7 @@ export = Event;
  * 2. one listener may belong to multiple owners
  * 3. one owner may have multiple listeners
  */
-declare class Event {
+export default class Event {
     static get DefaultOwner(): string;
     /**
      * Creates a new Event instance with the specified name.
@@ -54,7 +53,7 @@ declare class Event {
      * @param {Function} [callback] - The callback function to count
      * @returns {number}
      */
-    listenerCount(callback?: Function): number;
+    listenerCount(callback?: Function | undefined): number;
     /**
      * Returns a shallow copy of the registered callbacks array.
      * if one callback function is added multiple times, it will be returned multiple times.
@@ -102,7 +101,7 @@ declare class Event {
      * @param {Object} [owner] - The object that owns the callback (used for binding `this` context).
      * @returns {boolean}
      */
-    addOnceListener(callback: Function, owner?: Object): boolean;
+    addOnceListener(callback: Function, owner?: Object | undefined): boolean;
     /**
      * Adds a one-time event listener that will be automatically removed after being triggered once.
      * The listener will only be triggered if the event is pretended (simulated).
@@ -120,7 +119,7 @@ declare class Event {
      * @returns {boolean} Returns true if listener was added successfully, false if callback is nil or duplicate
      * @protected
      */
-    protected _addListener(callback: Function, owner?: any, isOnce?: boolean, isPrepend?: boolean): boolean;
+    protected _addListener(callback: Function, owner?: any, isOnce?: boolean | undefined, isPrepend?: boolean | undefined): boolean;
     /**
      * Removes a callback
      * @param {Function} callback - The callback function to remove.
@@ -139,4 +138,5 @@ declare class Event {
      */
     removeAllListeners(owner?: any): this;
 }
-import Listener = require("./listener");
+export { Event as EventType };
+import Listener from "./listener.js";

package/types/index.d.ts

@@ -1,2 +1,3 @@
+export default EventEmitter;
 export { EventEmitter };
-import EventEmitter = require("./event-emitter");
+import EventEmitter from "./event-emitter.js";

package/types/listener.d.ts

@@ -1,16 +1,16 @@
-export = Listener;
 /**
  * Wraps a function to be called when an event is fired.
+ * @typedef {import('./event.js').default} Event
  * @class Listener
  */
-declare class Listener {
+export default class Listener {
     /**
      * @param {Event} event
      * @param {function} callback - The function to be called when event is fired
      * @param {boolean} [isOnce=false] - is a one time listener?
      */
-    constructor(event: Event, callback: Function, isOnce?: boolean);
-    _event: Event;
+    constructor(event: Event, callback: Function, isOnce?: boolean | undefined);
+    _event: import("./event.js").default;
     _callback: Function;
     _isOnce: boolean;
     _owner: any;
@@ -18,9 +18,9 @@ declare class Listener {
      * Sets the owner of this listener.
      * @param {*} owner - The owner object to be associated with this listener.
      */
-    set owner(owner: any);
+    set owner(arg: any);
     get owner(): any;
-    get event(): Event;
+    get event(): import("./event.js").default;
     get isOnce(): boolean;
     /**
      * Checks if the provided function is the same as the listener's wrapped function.
@@ -43,4 +43,8 @@ declare class Listener {
      */
     listener(...args: any[]): any;
 }
-import Event = require("./event");
+export { Listener as ListenerType };
+/**
+ * Wraps a function to be called when an event is fired.
+ */
+export type Event = import('./event.js').default;