vrpc 3.0.0-alpha.1 → 3.0.1

package/CHANGELOG.md

@@ -5,9 +5,70 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [3.0.0-alpha.1]
+## [3.0.1] - Jan 24 2022
 
-### Changes
+### Fixed
+
+- non-functional event un-subscription on silent client disconnect and when
+  initially registered via `callAll`
+
+## [3.0.0] - Jan 20 2022
+
+### Added
+
+- `vrpcOn` / `vrpcOff` feature to client
+- tests exclusively for VrpcAdapter
+- support for `path.join(__dirname, <path>)` expressions when registering class
+
+### Fixed
+
+- unhandled promise rejection on initial connect timeout
+- missing documentation for VrpcNative
+- bug on new `vrpcOn` feature
+- bug while unregister event listeners via "off" or "removeAllListeners"
+
+### Changed
+
+- error messages as triggered on remote agents (now include context info)
+- removed obsolete public API from VrpcAdapter
+- internal handling of EventEmitter subscriptions
+  - now publishing a single message per event to a fixed topic
+  - dispatching happens by the broker not by the agent anymore
+  - this saves a lot of traffic when many clients subscribe to same events
+- reduced size of response messages by skipping redundant information
+- order of items within RPC message
+- promise rejection message as triggered on remote agents (now include context
+  info)
+
+## [3.0.0-alpha.3] - 25 Nov 2021
+
+### Fixed
+
+- missing 'create' event in VrpcAdapter
+- respecting isolation state in callAll
+
+### Changed
+
+- cleaned API and tests from deprecation supports, those will now result in
+  errors
+- intercepting return value of EventEmitter functions and changing it from
+  potentially gigantic object (as it returns `this`) to `true`
+
+## [3.0.0-alpha.2] - 19 Nov 2021
+
+### Fixed
+
+- leaking event registrations on remote-controlled instance when event consumer
+  was not creator of the instance
+
+## Changed
+
+- reduced payload of callback message by omitting the original return value
+- changed prefix of mqtt client id to `vc3` and `va3`, respectively
+
+## [3.0.0-alpha.1] - 10 Nov 2021
+
+### Changed
 
 - layout and content of this repository, only javascript related code is left
 - naming of public API classes is made consistent

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 - 2021 Dr. Burkhard C. Heisen
+Copyright (c) 2018 - 2022 Dr. Burkhard C. Heisen
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,11 +1,10 @@
 # VRPC - Variadic Remote Procedure Calls
 
-[![Build Status](https://travis-ci.com/heisenware/vrpc.svg?branch=master)](https://travis-ci.com/heisenware/vrpc)
-[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/heisenware/vrpc/master/LICENSE)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/heisenware/vrpc-js/master/LICENSE)
 [![Semver](https://img.shields.io/badge/semver-2.0.0-blue)](https://semver.org/spec/v2.0.0.html)
-[![GitHub Releases](https://img.shields.io/github/tag/heisenware/vrpc.svg)](https://github.com/heisenware/vrpc/tag)
-[![GitHub Issues](https://img.shields.io/github/issues/heisenware/vrpc.svg)](http://github.com/heisenware/vrpc/issues)
-![ci](https://github.com/heisenware/vrpc/actions/workflows/ci.yml/badge.svg)
+[![GitHub Releases](https://img.shields.io/github/tag/heisenware/vrpc-js.svg)](https://github.com/heisenware/vrpc-js/tag)
+[![GitHub Issues](https://img.shields.io/github/issues/heisenware/vrpc-js.svg)](http://github.com/heisenware/vrpc-js/issues)
+![ci](https://github.com/heisenware/vrpc-js/actions/workflows/ci.yml/badge.svg)
 
 ## Visit our website: [vrpc.io](https://vrpc.io)
 
@@ -16,22 +15,20 @@ VRPC - Variadic Remote Procedure Calls - is an enhancement of the old RPC
 written in any programming language by functions written in any other (or the
 same) programming language. Unlike RPC, VRPC furthermore supports:
 
-- non-intrusive adaption of existing code, making it remotely callable
+- non-intrusive adaption of existing code, making it callable remotely
 - remote function calls on many distributed receivers at the same time (one
   client - multiple agents)
 - service discovery
 - outbound-connection-only network architecture (using MQTT technology)
-- isolated (multi-tenant) and shared access modes to remotely available
-  resources
+- isolated (multi-tenant) and shared access modes to remote resources
 - asynchronous language constructs (callbacks, promises, event-loops)
 - OOP (classes, objects, member functions) and functional (lambda) patterns
 - exception forwarding
 
 VRPC is available for an entire spectrum of programming technologies including
-embedded (Arduino, header-only C++, etc.), data-science (Python, R,
-etc.), and web (Javascript, React, etc.) technologies.
+embedded, data-science, and web technologies.
 
-As a robust and highly performing communication system it can build the
+As a robust and highly performing communication system, it can build the
 foundation of complex digitization projects in the area of (I)IoT or
 Cloud-Computing.
 
@@ -39,10 +36,10 @@ Cloud-Computing.
 
 Understand how to use it by looking at the examples:
 
-- [Agent Example](examples/agent/README.md)
-- [Client Example](examples/client/README.md)
-- [Simple C++ Embedding Example](examples/native1/README.md)
-- [Advanced C++ Embedding Example](examples/native2/README.md)
+- [Agent Example](examples/01-agent/README.md)
+- [Client Example](examples/02-client/README.md)
+- [Simple C++ Embedding Example](examples/03-native-simple/README.md)
+- [Advanced C++ Embedding Example](examples/04-native-advanced/README.md)
 
 Get all the details by reading the documentation: