@nymphjs/pubsub 1.0.0-beta.13 → 1.0.0-beta.131

package/dist/PubSub.d.ts

@@ -1,47 +1,110 @@
 import { Nymph } from '@nymphjs/nymph';
-import { request, server as WebSocketServer, connection, Message } from 'websocket';
-import { Config } from './conf';
-import type { QuerySubscriptionData } from './PubSub.types';
+import ws from 'websocket';
+import { Config } from './conf/index.js';
+import type { QuerySubscriptionData, PublishEntityMessageData } from './PubSub.types.js';
+/**
+ * A publish/subscribe server for Nymph.
+ *
+ * Written by Hunter Perrin for SciActive.
+ *
+ * @author Hunter Perrin <hperrin@port87.com>
+ * @copyright SciActive Inc
+ * @see http://nymph.io/
+ */
 export default class PubSub {
+    /**
+     * The Nymph instance.
+     */
     nymph: Nymph;
+    /**
+     * The PubSub config.
+     */
     config: Config;
-    server: WebSocketServer;
+    /**
+     * The WebSocket server.
+     */
+    server: ws.server;
     private sessions;
     protected querySubs: {
         [etype: string]: {
-            [query: string]: Map<connection, QuerySubscriptionData>;
+            [query: string]: Map<ws.connection, QuerySubscriptionData>;
         };
     };
     protected uidSubs: {
-        [uidName: string]: Map<connection, {
+        [uidName: string]: Map<ws.connection, {
             count: boolean;
         }>;
     };
+    protected outgoingClientMessages: Map<ws.connection, {
+        subscription: QuerySubscriptionData;
+        publish: PublishEntityMessageData;
+    }[]>;
+    protected outgoingClientMessagesTimeout: NodeJS.Immediate | null;
     protected static transactionPublishes: {
         nymph: Nymph;
         payload: string;
         config: Config;
     }[];
-    static initPublisher(config: Partial<Config>, nymph: Nymph): void;
+    static initPublisher(config: Partial<Config>, nymph: Nymph): () => void;
     private static publish;
-    private static isOrIsDescendent;
+    private static isOrIsDescendant;
     private static publishTransactionPublishes;
     private static removeTransactionPublishes;
-    constructor(config: Partial<Config>, nymph: Nymph, server: WebSocketServer);
+    /**
+     * Initialize Nymph PubSub.
+     *
+     * @param config The PubSub configuration.
+     */
+    constructor(config: Partial<Config>, nymph: Nymph, server: ws.server);
     close(): void;
-    handleRequest(request: request): void;
-    onMessage(from: connection, msg: Message): Promise<void>;
-    onClose(conn: connection, description: string): void;
-    onError(conn: connection, e: Error): void;
+    handleRequest(request: ws.request): void;
+    /**
+     * Handle a message from a client.
+     */
+    onMessage(from: ws.connection, msg: ws.Message): Promise<void>;
+    /**
+     * Clean up after users who leave.
+     */
+    onClose(conn: ws.connection, description: string): void;
+    onError(conn: ws.connection, e: Error): void;
+    /**
+     * Handle an authentication from a client.
+     */
     private handleAuthentication;
+    /**
+     * Handle a subscribe or unsubscribe from a client.
+     */
     private handleSubscription;
+    /**
+     * Handle a subscribe or unsubscribe for a query from a client.
+     */
     private handleSubscriptionQuery;
+    /**
+     * Handle a subscribe or unsubscribe for a UID from a client.
+     */
     private handleSubscriptionUid;
+    /**
+     * Handle a publish from a client.
+     */
     private handlePublish;
+    /**
+     * Handle an entity publish from a client.
+     */
     private handlePublishEntity;
-    private updateClient;
+    private addOutgoingClientMessage;
+    private updateClients;
+    /**
+     * Handle a UID publish from a client.
+     */
     private handlePublishUid;
+    /**
+     * Relay publish data to other servers.
+     */
     private relay;
     private findQRefQueries;
+    /**
+     * This translates qref selectors into ref selectors using the "current" GUID
+     * list in the existing subscriptions.
+     */
     private translateQRefSelectors;
 }