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

package/src/PubSub.types.ts

@@ -17,7 +17,8 @@ export type QuerySubscriptionData = {
 
 export type AuthenticateMessageData = {
   action: 'authenticate';
-  token: string;
+  authToken: string;
+  switchToken?: string;
 };
 
 export type QuerySubscribeMessageData = {
@@ -33,8 +34,7 @@ export type UidSubscribeMessageData = {
 };
 
 export type SubscribeMessageData =
-  | QuerySubscribeMessageData
-  | UidSubscribeMessageData;
+  QuerySubscribeMessageData | UidSubscribeMessageData;
 
 export type PublishEntityMessageData = {
   action: 'publish';
@@ -54,13 +54,18 @@ export type PublishUidMessageData = {
 };
 
 export type PublishMessageData =
-  | PublishEntityMessageData
-  | PublishUidMessageData;
+  PublishEntityMessageData | PublishUidMessageData;
+
+export type MultipleMessageData = {
+  action: 'multiple';
+  messages: MessageData[];
+};
 
 export type MessageData =
   | AuthenticateMessageData
   | SubscribeMessageData
-  | PublishMessageData;
+  | PublishMessageData
+  | MultipleMessageData;
 
 export type MessageOptions = Options & {
   class: string;

package/src/conf/defaults.ts

@@ -1,9 +1,9 @@
-import { Config } from './d';
+import type { Config } from './index.js';
 
 export default {
   originIsAllowed: () => {
     throw new Error(
-      'You must provide a "originIsAllowed" function to PubSub config to determine if client origin is allowed.'
+      'You must provide a "originIsAllowed" function to PubSub config to determine if client origin is allowed.',
     );
   },
   entries: ['ws://127.0.0.1:8080/'],

package/src/conf/index.ts

@@ -1,4 +1,33 @@
-export { Config } from './d';
+/**
+ * Nymph PubSub Config
+ */
+export interface Config {
+  /**
+   * Determine whether a client's origin is allowed to connect.
+   */
+  originIsAllowed: (origin: string) => boolean;
+  /**
+   * The URLs of the Nymph-PubSub servers to directly publish to. These servers
+   * are how this host will enter the PubSub network. If you only have one
+   * PubSub server, it needs to be listed here.
+   */
+  entries: string[];
+  /**
+   * The URLs of additional Nymph-PubSub servers to relay publishes to. If this
+   * host is a PubSub server, these servers are how it will continue into your
+   * PubSub network.
+   */
+  relays: string[];
+  /**
+   * Allow clients to request to be notified when other clients subscribe to the
+   * same queries.
+   */
+  broadcastCounts: boolean;
+  /**
+   * Function to log PubSub info/error messages.
+   */
+  logger: (...args: any[]) => void;
+}
 
-import defaults from './defaults';
+import defaults from './defaults.js';
 export { defaults as ConfigDefaults };

package/src/createServer.ts

@@ -1,14 +1,14 @@
-import type { Nymph, TilmeldInterface } from '@nymphjs/nymph';
-import http from 'http';
-import { server as WebSocketServer } from 'websocket';
+import http from 'node:http';
+import type { Nymph } from '@nymphjs/nymph';
+import ws from 'websocket';
 
-import { Config, ConfigDefaults as defaults } from './conf';
-import PubSub from './PubSub';
+import { Config, ConfigDefaults as defaults } from './conf/index.js';
+import PubSub from './PubSub.js';
 
 export default function createServer(
   port = 8080,
   config: Partial<Config> = {},
-  nymph: Nymph
+  nymph: Nymph,
 ) {
   const server = http.createServer((_request, response) => {
     response.writeHead(404);
@@ -19,11 +19,11 @@ export default function createServer(
     (config.logger ?? defaults.logger)(
       'log',
       new Date().toISOString(),
-      `Nymph-PubSub server started listening on port ${port}.`
+      `Nymph-PubSub server started listening on port ${port}.`,
     );
   });
 
-  const wsServer = new WebSocketServer({
+  const wsServer = new ws.server({
     httpServer: listener,
     // You should not use autoAcceptConnections for production
     // applications, as it defeats all standard cross-origin protection

package/src/index.ts

@@ -1,10 +1,10 @@
-export * from './conf';
+export * from './conf/index.js';
 
-import PubSub from './PubSub';
+import PubSub from './PubSub.js';
 export { PubSub };
 
-export * from './PubSub.types';
+export * from './PubSub.types.js';
 
-import createServer from './createServer';
+import createServer from './createServer.js';
 export { createServer };
 export default createServer;

package/tsconfig.json

@@ -2,10 +2,13 @@
   "extends": "@tsconfig/recommended/tsconfig.json",
 
   "compilerOptions": {
-    "lib": ["ES2021"],
-    "target": "ES2021",
+    "types": ["node", "jest"],
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "lib": ["es2024"],
+    "target": "es2024",
     "noImplicitAny": true,
-    "removeComments": true,
+    "removeComments": false,
     "sourceMap": true,
     "outDir": "dist",
     "resolveJsonModule": true,

package/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"]
+}

package/dist/conf/d.d.ts

@@ -1,7 +0,0 @@
-export interface Config {
-    originIsAllowed: (origin: string) => boolean;
-    entries: string[];
-    relays: string[];
-    broadcastCounts: boolean;
-    logger: (...args: any[]) => void;
-}

package/dist/conf/d.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=d.js.map

package/dist/conf/d.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"d.js","sourceRoot":"","sources":["../../src/conf/d.ts"],"names":[],"mappings":""}

package/src/conf/d.ts

@@ -1,30 +0,0 @@
-/**
- * Nymph PubSub Config
- */
-export interface Config {
-  /**
-   * Determine whether a client's origin is allowed to connect.
-   */
-  originIsAllowed: (origin: string) => boolean;
-  /**
-   * The URLs of the Nymph-PubSub servers to directly publish to. These servers
-   * are how this host will enter the PubSub network. If you only have one
-   * PubSub server, it needs to be listed here.
-   */
-  entries: string[];
-  /**
-   * The URLs of additional Nymph-PubSub servers to relay publishes to. If this
-   * host is a PubSub server, these servers are how it will continue into your
-   * PubSub network.
-   */
-  relays: string[];
-  /**
-   * Allow clients to request to be notified when other clients subscribe to the
-   * same queries.
-   */
-  broadcastCounts: boolean;
-  /**
-   * Function to log PubSub info/error messages.
-   */
-  logger: (...args: any[]) => void;
-}