Flatten lib namespace

Move all functions and classes currently available through lib/name and
libName to be under a single flat namespace in lib.  This make
reorganising the lib namespace much simpler as the location of symbols
can move without breaking the consumers of lib.

The multi-entrypoint design was already problematic for the web plugin
system which couldn't effectively use it due to how webpack's shared
module system is awkward to set up with multiple entrypoints per package.
This commit is contained in:
Hornwitser committed 2023-07-28 16:03:29 +02:00
1 parent bb58670597
commit bfe119eaa3
143 files changed
+1798 -1918

No files matched your search

+11 -11
View File
@@ -15,7 +15,7 @@ const ExponentialBackoff = require("../ExponentialBackoff");
* Base connector for links
*
* @extends events.EventEmitter
* @memberof module:lib/link
* @memberof module:lib
*/
class BaseConnector extends events.EventEmitter {
constructor(src, dst) {
@@ -76,8 +76,8 @@ class BaseConnector extends events.EventEmitter {
/**
* Base connector for links
*
* @extends module:lib/link.BaseConnector
* @memberof module:lib/link
* @extends module:lib.BaseConnector
* @memberof module:lib
*/
class WebSocketBaseConnector extends BaseConnector {
constructor(src, dst) {
@@ -231,7 +231,7 @@ class WebSocketBaseConnector extends BaseConnector {
* This is a low level method that should only be used for implementing
* links. See sendTo for sending requests and events.
*
* @param {module:lib/data.Message} message - Message to send.
* @param {module:lib.Message} message - Message to send.
*/
send(message) {
if (!["connected", "resuming"].includes(this._state)) {
@@ -313,8 +313,8 @@ class WebSocketBaseConnector extends BaseConnector {
/**
* Connector for controller clients
*
* @extends module:lib/link.WebSocketBaseConnector
* @memberof module:lib/link
* @extends module:lib.WebSocketBaseConnector
* @memberof module:lib
*/
class WebSocketClientConnector extends WebSocketBaseConnector {
constructor(url, maxReconnectDelay, tlsCa = null) {
@@ -360,7 +360,7 @@ class WebSocketClientConnector extends WebSocketBaseConnector {
* Used in the register function in order to send the handshake messages
* over the WebSocket.
*
* @param {module:lib/data.Message} message - Message to send.
* @param {module:lib.Message} message - Message to send.
*/
sendHandshake(message) {
this._check("connecting", "resuming");
@@ -647,7 +647,7 @@ class WebSocketClientConnector extends WebSocketBaseConnector {
* Connector for in-memory local links
*
* @extends events.EventEmitter
* @memberof module:lib/link
* @memberof module:lib
*/
class VirtualConnector extends BaseConnector {
constructor(src, dst) {
@@ -662,8 +662,8 @@ class VirtualConnector extends BaseConnector {
* Creates two virtual connectors that are liked to each othes such that
* a message sent on one is received by the other.
*
* @param {module:lib/data.Address} src - Source for obverse connector
* @param {module:lib/data.Address} dst - destination for obverse connector
* @param {module:lib.Address} src - Source for obverse connector
* @param {module:lib.Address} dst - destination for obverse connector
* @returns {Array} two virtuarl connectors.
*/
static makePair(src, dst) {
@@ -677,7 +677,7 @@ class VirtualConnector extends BaseConnector {
/**
* Send a message to the other end of the connector
*
* @param {module:lib/data.Message} message - Message type to send.
* @param {module:lib.Message} message - Message type to send.
*/
send(message) {
this.other.emit("message", message);
+8 -8
View File
@@ -17,7 +17,7 @@ const { dataClasses } = require("./messages");
/**
* Common interface for server and client connections
*
* @memberof module:lib/link
* @memberof module:lib
*/
class Link {
constructor(connector) {
@@ -95,8 +95,8 @@ class Link {
* Validates and invokes the handler and/or waiters for a message that has
* been received. An unhandled message is considered to be an error.
*
* @param {module:lib/data.Message} message - Message to process.
* @throws {module:lib/errors.InvalidMessage} if the message is invalid or not handled.
* @param {module:lib.Message} message - Message to process.
* @throws {module:lib.InvalidMessage} if the message is invalid or not handled.
*/
_processMessage(message) {
if (!["request", "response", "responseError", "event"].includes(message.type)) {
@@ -149,8 +149,8 @@ class Link {
*
* Should be overridden by sub-classes to validate messages received.
*
* @param {module:lib/data.Message} message - Message to check.
* @throws {module:lib/errors.InvalidMessage} if the message is invalid.
* @param {module:lib.Message} message - Message to check.
* @throws {module:lib.InvalidMessage} if the message is invalid.
*/
validateIngress(message) { }
@@ -222,9 +222,9 @@ class Link {
* Called when an request or event is received by a control connector.
* Should be overridden by sub-classes to validate messages received.
*
* @param {module:lib/data.Message} message - Message to check.
* @param {module:lib.Message} message - Message to check.
* @param {object} entry - Request or Event entry for this Message.
* @throws {module:lib/errors.PermissionError} if unauthorized.
* @throws {module:lib.PermissionError} if unauthorized.
*/
validatePermission(message, entry) { }
@@ -380,7 +380,7 @@ class Link {
/**
* Send a request or event to the given address
*
* @param {*|module:lib/data.Address} destination - Where to send it
* @param {*|module:lib.Address} destination - Where to send it
* @param {*} requestOrEvent - Request or event to send
* @returns {Promise<*>|undefined}
* Promise that resolves to the response if a request was sent or