@uxland/event-aggregator - npm Package Compare versions

Comparing version 1.0.0-alpha.5 to 1.0.0-alpha.6

CHANGELOG.md

@@ -6,2 +6,10 @@ # Change Log
 
+# [1.0.0-alpha.6](https://github.com/uxland/uxland/compare/@uxland/event-aggregator@1.0.0-alpha.5...@uxland/event-aggregator@1.0.0-alpha.6) (2020-02-20)
+
+**Note:** Version bump only for package @uxland/event-aggregator
+
+
+
+
+
 # [1.0.0-alpha.5](https://github.com/uxland/uxland/compare/@uxland/event-aggregator@1.0.0-alpha.4...@uxland/event-aggregator@1.0.0-alpha.5) (2020-02-20)
@@ -8,0 +16,0 @@

dist/index.js

@@ -1,2 +0,2 @@
-// Event Aggregator v1.0.0-alpha.4
+// Event Aggregator v1.0.0-alpha.5
 // https://github.com/uxland/uxland/tree/master/packages/event-aggregator#readme
@@ -11,2 +11,25 @@ // (c) 2020-2020 UXLand
 
+	/*
+	 * MIT License
+	 *
+	 * Copyright (c) 2020 UXLand
+	 *
+	 * Permission is hereby granted, free of charge, to any person obtaining a copy of
+	 * this software and associated documentation files (the "Software"), to deal in
+	 * the Software without restriction, including without limitation the rights to use,
+	 * copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+	 * Software, and to permit persons to whom the Software is furnished to do so,
+	 * subject to the following conditions:
+	 *
+	 * The above copyright notice and this permission notice shall be included in all
+	 * copies or substantial portions of the Software.
+	 *
+	 * 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 OR
+	 * COPYRIGHT HOLDERS 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.
+	 */
+
 	Object.defineProperty(exports, "__esModule", {
@@ -17,5 +40,7 @@ value: true
 	var tslib_1 = require("tslib");
+	/** @namespace EventAggregator */
 
+
 	tslib_1.__exportStar(require("./event-aggregator"), exports);
 
 })));

lib/event-aggregator.d.ts

@@ -13,6 +13,57 @@ export interface Subscription {
 }
+/**
+ * Event Aggregator singleton
+ * @memberof EventAggregator
+ * @constant
+ * @name eventAggregator
+ * @since v1.0.0
+ */
 export declare const eventAggregator: EventAggregator;
+/**
+ * Subscribes to a message channel or message type
+ * @memberof EventAggregator
+ * @function
+ * @name subscribe
+ * @since v1.0.0
+ * @param {string} event The event channel or event data type
+ * @param {EventAggregator.EventCallback} callback The callback to be invoked when when the specified message is published
+ * @returns {EventAggregator.Subscription}
+ * @throws Event channel/type is invalid
+ * @example
+ *
+ * `TBD`
+ *
+ */
 export declare const subscribe: any;
+/**
+ * Subscribes to a message channel or message type, then disposes the subscription automatically after the first message is received
+ * @memberof EventAggregator
+ * @function
+ * @name subscribeOnce
+ * @since v1.0.0
+ * @param {string} event The event channel or event data type
+ * @param {EventAggregator.EventCallback} callback The callback to be invoked when when the specified message is published
+ * @returns {EventAggregator.Subscription}
+ * @example
+ *
+ * `TBD`
+ *
+ */
 export declare const subscribeOnce: any;
+/**
+ * Publishes a message
+ * @memberof EventAggregator
+ * @function
+ * @name publish
+ * @since v1.0.0
+ * @param {string} event The event or channel to publish to
+ * @param {*} data The data to publish on the channel
+ * @returns {void|never}
+ * @throws Event channel/type is invalid
+ * @example
+ *
+ * `TBD`
+ *
+ */
 export declare const publish: any;
 export {};

lib/event-aggregator.js

 "use strict";
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020 UXLand
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+ * Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * 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 OR
+ * COPYRIGHT HOLDERS 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.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 let STUB = 1;
+/**
+ * Subscription interface
+ * @memberof EventAggregator
+ * @interface Subscription
+ * @property {function} dispose Subscription disposer
+ */
 STUB = 1;
+/**
+ * EventCallback type
+ * @memberof EventAggregator
+ * @typedef {function} EventCallback
+ * @param {*=} data Event payload
+ * @param {string=} event Event ID
+ * @returns {void|never}
+ */
 STUB = 1;
@@ -94,5 +130,56 @@ class Handler {
 }
+/**
+ * Event Aggregator singleton
+ * @memberof EventAggregator
+ * @constant
+ * @name eventAggregator
+ * @since v1.0.0
+ */
 exports.eventAggregator = new EventAggregator();
+/**
+ * Subscribes to a message channel or message type
+ * @memberof EventAggregator
+ * @function
+ * @name subscribe
+ * @since v1.0.0
+ * @param {string} event The event channel or event data type
+ * @param {EventAggregator.EventCallback} callback The callback to be invoked when when the specified message is published
+ * @returns {EventAggregator.Subscription}
+ * @throws Event channel/type is invalid
+ * @example
+ *
+ * `TBD`
+ *
+ */
 exports.subscribe = exports.eventAggregator.subscribe.bind(exports.eventAggregator);
+/**
+ * Subscribes to a message channel or message type, then disposes the subscription automatically after the first message is received
+ * @memberof EventAggregator
+ * @function
+ * @name subscribeOnce
+ * @since v1.0.0
+ * @param {string} event The event channel or event data type
+ * @param {EventAggregator.EventCallback} callback The callback to be invoked when when the specified message is published
+ * @returns {EventAggregator.Subscription}
+ * @example
+ *
+ * `TBD`
+ *
+ */
 exports.subscribeOnce = exports.eventAggregator.subscribeOnce.bind(exports.eventAggregator);
+/**
+ * Publishes a message
+ * @memberof EventAggregator
+ * @function
+ * @name publish
+ * @since v1.0.0
+ * @param {string} event The event or channel to publish to
+ * @param {*} data The data to publish on the channel
+ * @returns {void|never}
+ * @throws Event channel/type is invalid
+ * @example
+ *
+ * `TBD`
+ *
+ */
 exports.publish = exports.eventAggregator.publish.bind(exports.eventAggregator);

lib/index.d.ts

@@ -0,1 +1,2 @@
+/** @namespace EventAggregator */
 export * from './event-aggregator';

lib/index.js

 "use strict";
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020 UXLand
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+ * Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * 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 OR
+ * COPYRIGHT HOLDERS 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.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+/** @namespace EventAggregator */
 tslib_1.__exportStar(require("./event-aggregator"), exports);

package.json

 {
   "name": "@uxland/event-aggregator",
-  "version": "1.0.0-alpha.5",
+  "version": "1.0.0-alpha.6",
   "description": "Event Aggregator",
@@ -28,4 +28,3 @@ "author": "UXLand <[e-mail]>",
     "build:es": "tsc -p tsconfig.json --outDir es --module esnext --noEmit false",
-    "build:cjs": "tsc -p tsconfig.json --outDir lib --noEmit false --declaration",
-    "build:cjs:docs": "tsc -p tsconfig.json --outDir tmp --noEmit false --declaration --removeComments false",
+    "build:cjs": "tsc -p tsconfig.json --outDir lib --noEmit false --declaration  --removeComments false",
     "build:umd": "cross-env NODE_ENV=development rollup -c -o dist/index.js",
@@ -46,3 +45,6 @@ "build:umd:min": "cross-env NODE_ENV=production rollup -c -o dist/index.min.js",
     "test": "yarn test:unit",
-    "jsdoc": "yarn build:cjs:docs && rimraf docs && jsdoc -r ./tmp -c jsdoc.conf.js && rimraf tmp"
+    "jsdoc": "yarn build:cjs && rimraf docs && jsdoc -r ./lib -c jsdoc.conf.js",
+    "jsdoc:styles": "cat ../../resources/docs/custom.css >> ./docs/$npm_package_name/$npm_package_version/styles/jsdoc.css",
+    "jsdoc:mv": "mkdirp ../../docs/$npm_package_name/$npm_package_version && ncp docs/$npm_package_name/$npm_package_version ../../docs/$npm_package_name/$npm_package_version",
+    "postjsdoc": "yarn jsdoc:styles && yarn jsdoc:mv"
   },
@@ -58,2 +60,3 @@ "bugs": {
     "@types/ramda": "^0.26.41",
+    "cat": "^0.2.0",
     "cross-env": "^7.0.0",
@@ -76,3 +79,3 @@ "cucumber": "^6.0.5",
   },
-  "gitHead": "b4dc4405142fa2cbe74aafc787983eac328d85a5"
+  "gitHead": "788f1de589336c5a6216279c07006f6439ea3c5e"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

19916

increased by54.54%

Lines of code

433

increased by74.6%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

19

increased by5.56%

No dependency changes