@pacem/pacem-networking 1.0.0-bessel → 1.0.0-dirac

package/dist/esm/hub-proxy.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-networking v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-networking v1.0.0-dirac (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */
@@ -13,6 +13,7 @@ import { P, CustomElement, Watch, PropertyConverters, Utils, PropertyChangeEvent
 //namespace Pacem.Components.Networking {
 const API_JS = 'https://cdn.jsdelivr.net/npm/@microsoft/signalr@10.0.0/dist/browser/signalr.min.js'; // 'https://cdnjs.cloudflare.com/ajax/libs/microsoft-signalr/10.0.0/signalr.min.js'
 const consts = { API_JS };
+/** Subscribes to a hub method (or stream) exposed by the ancestor {@link PacemHubProxyElement}, dispatching a `receive` event for every incoming message. */
 let PacemHubListenerElement = class PacemHubListenerElement extends Components.PacemItemElement {
     constructor() {
         super(...arguments);
@@ -141,28 +142,44 @@ PacemHubListenerElement = __decorate([
     CustomElement({ tagName: P + '-hub-listener' })
 ], PacemHubListenerElement);
 export { PacemHubListenerElement };
+/** Wraps a SignalR hub connection, dispatching its connection state and exposing `invoke`/`send` to registered {@link PacemHubListenerElement} children. */
 let PacemHubProxyElement = class PacemHubProxyElement extends Components.PacemItemsContainerElement {
+    /** @inheritdoc */
     validate(item) {
         return item instanceof PacemHubListenerElement;
     }
+    /** @readonly Gets the underlying `signalR.HubConnection` instance, if connected. */
     get connection() {
         return this._hub;
     }
+    /**
+     * Invokes a hub method and waits for a result from the server.
+     * @param method Name of the hub method to invoke
+     * @param args Arguments to pass to the hub method
+     * @returns A promise that resolves with the server response
+     */
     invoke(method, ...args) {
         if (this.connected) {
             return this._hub.invoke.apply(this._hub, arguments);
         }
         throw 'Hub is not connected. Cannot call `invoke` method.';
     }
+    /**
+     * Invokes a hub method without waiting for a result from the server.
+     * @param method Name of the hub method to invoke
+     * @param args Arguments to pass to the hub method
+     */
     send(method, ...args) {
         if (this.connected) {
             return this._hub.send(method, ...args);
         }
         throw 'Hub is not connected. Cannot call `send` method.';
     }
+    /** (Re)establishes the hub connection. */
     start() {
         return this._resetProxy();
     }
+    /** Closes the hub connection, if connected. */
     async stop() {
         if (this.connected) {
             await this._hub.stop();

package/dist/esm/index-components-networking.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-networking v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-networking v1.0.0-dirac (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */

package/dist/esm/index-components.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-networking v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-networking v1.0.0-dirac (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */

package/dist/esm/index-iife.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-networking v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-networking v1.0.0-dirac (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */

package/dist/esm/index.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-networking v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-networking v1.0.0-dirac (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */

package/dist/esm/sse-proxy.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-networking v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-networking v1.0.0-dirac (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */
@@ -11,6 +11,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 };
 import { P, CustomElement, Watch, PropertyConverters, Utils, PropertyChangeEventName, Debounce, Components } from '@pacem/pacem-core';
 //namespace Pacem.Components.Networking {
+/** Subscribes to a named event exposed by the ancestor {@link PacemServerSentEventsProxyElement}'s `EventSource`, dispatching a `receive` event for every incoming message. */
 let PacemServerSentEventsListenerElement = class PacemServerSentEventsListenerElement extends Components.PacemItemElement {
     constructor() {
         super(...arguments);
@@ -99,6 +100,7 @@ PacemServerSentEventsListenerElement = __decorate([
     CustomElement({ tagName: P + '-sse-listener' })
 ], PacemServerSentEventsListenerElement);
 export { PacemServerSentEventsListenerElement };
+/** Wraps a browser `EventSource`, opening a Server-Sent Events connection and dispatching its connection state to registered {@link PacemServerSentEventsListenerElement} children. */
 let PacemServerSentEventsProxyElement = class PacemServerSentEventsProxyElement extends Components.PacemItemsContainerElement {
     constructor() {
         super(...arguments);
@@ -113,6 +115,7 @@ let PacemServerSentEventsProxyElement = class PacemServerSentEventsProxyElement
             this.dispatchEvent(new CustomEvent('receive', { detail: e.data }));
         };
     }
+    /** @inheritdoc */
     validate(item) {
         return item instanceof PacemServerSentEventsListenerElement;
     }
@@ -146,6 +149,7 @@ let PacemServerSentEventsProxyElement = class PacemServerSentEventsProxyElement
             evtSource.onerror = this._errorHandler;
         }
     }
+    /** @readonly Gets the underlying `EventSource` instance, if connected. */
     get eventSource() {
         return this.#evtSource;
     }

package/package.json

@@ -4,6 +4,7 @@
     "dist/browser/*.*",
     "dist/bundle/*.*",
     "dist/esm/*.*",
+    "dist/docs/*.*",
     "typings/*.*",
     "README.md",
     "LICENSE",
@@ -24,7 +25,7 @@
       "types": "./typings/index.d.ts"
     }
   },
-  "version": "1.0.0-bessel",
+  "version": "1.0.0-dirac",
   "author": {
     "name": "Pacem",
     "url": "https://pacem.it"

package/typings/index.d.ts

@@ -7,6 +7,7 @@ export declare namespace Components {
     }
 }
 
+/** Signature of a callback invoked when a hub method emits a value. */
 declare type HubMethodCallback = (...args: any[]) => void;
 
 export declare namespace Networking {
@@ -19,6 +20,7 @@ export declare namespace Networking {
     }
 }
 
+/** Subscribes to a hub method (or stream) exposed by the ancestor {@link PacemHubProxyElement}, dispatching a `receive` event for every incoming message. */
 declare class PacemHubListenerElement extends Components_2.PacemItemElement {
     #private;
     /** The method that the listener should subscribe to. */
@@ -44,16 +46,35 @@ declare class PacemHubListenerElement extends Components_2.PacemItemElement {
     propertyChangedCallback(name: string, old: any, val: any, first?: boolean): void;
 }
 
+/** Wraps a SignalR hub connection, dispatching its connection state and exposing `invoke`/`send` to registered {@link PacemHubListenerElement} children. */
 declare class PacemHubProxyElement extends Components_2.PacemItemsContainerElement<PacemHubListenerElement> {
+    /** @inheritdoc */
     validate(item: PacemHubListenerElement): boolean;
+    /** Gets or sets the url of the SignalR hub to connect to. */
     url: string;
+    /** Gets or sets the access token used to authenticate against the hub. */
     accesstoken: string;
+    /** @readonly Gets whether the hub connection is currently established. */
     connected: boolean;
     private _hub;
+    /** @readonly Gets the underlying `signalR.HubConnection` instance, if connected. */
     get connection(): HubConnection;
+    /**
+     * Invokes a hub method and waits for a result from the server.
+     * @param method Name of the hub method to invoke
+     * @param args Arguments to pass to the hub method
+     * @returns A promise that resolves with the server response
+     */
     invoke(method: string, ...args: any[]): PromiseLike<any>;
+    /**
+     * Invokes a hub method without waiting for a result from the server.
+     * @param method Name of the hub method to invoke
+     * @param args Arguments to pass to the hub method
+     */
     send(method: string, ...args: any[]): PromiseLike<void>;
+    /** (Re)establishes the hub connection. */
     start(): Promise<void>;
+    /** Closes the hub connection, if connected. */
     stop(): Promise<void>;
     propertyChangedCallback(name: string, old: any, val: any, first?: boolean): void;
     viewActivatedCallback(): void;
@@ -63,6 +84,7 @@ declare class PacemHubProxyElement extends Components_2.PacemItemsContainerEleme
     private _setupProxy;
 }
 
+/** Subscribes to a named event exposed by the ancestor {@link PacemServerSentEventsProxyElement}'s `EventSource`, dispatching a `receive` event for every incoming message. */
 declare class PacemServerSentEventsListenerElement extends Components_2.PacemItemElement {
     /** The method that the listener should subscribe to. */
     method: string;
@@ -81,16 +103,21 @@ declare class PacemServerSentEventsListenerElement extends Components_2.PacemIte
     propertyChangedCallback(name: string, old: any, val: any, first?: boolean): void;
 }
 
+/** Wraps a browser `EventSource`, opening a Server-Sent Events connection and dispatching its connection state to registered {@link PacemServerSentEventsListenerElement} children. */
 declare class PacemServerSentEventsProxyElement extends Components_2.PacemItemsContainerElement<PacemServerSentEventsListenerElement> {
     #private;
+    /** @inheritdoc */
     validate(item: PacemServerSentEventsListenerElement): boolean;
+    /** Gets or sets the url of the Server-Sent Events endpoint to connect to. */
     url: string;
+    /** @readonly Gets whether the event source connection is currently active. */
     connected: boolean;
     viewActivatedCallback(): void;
     disconnectedCallback(): void;
     propertyChangedCallback(name: string, old: any, val: any, first?: boolean): void;
     private _restart;
     private _start;
+    /** @readonly Gets the underlying `EventSource` instance, if connected. */
     get eventSource(): EventSource;
     private _connectHandler;
     private _errorHandler;