@hocuspocus/extension-webhook 2.15.2 → 3.0.4-rc.0

package/dist/packages/server/src/Connection.d.ts

@@ -1,32 +1,21 @@
 /// <reference types="node" />
-/// <reference types="node" />
-import { IncomingMessage as HTTPIncomingMessage } from 'http';
-import AsyncLock from 'async-lock';
-import WebSocket from 'ws';
-import { CloseEvent } from '@hocuspocus/common';
-import Document from './Document.js';
-import { Debugger } from './Debugger.js';
-import { onStatelessPayload } from './types.js';
+import type { IncomingMessage as HTTPIncomingMessage } from 'http';
+import type WebSocket from 'ws';
+import { type CloseEvent } from '@hocuspocus/common';
+import type Document from './Document.js';
+import type { onStatelessPayload } from './types.js';
 export declare class Connection {
     webSocket: WebSocket;
     context: any;
     document: Document;
-    pingInterval: NodeJS.Timeout;
-    pongReceived: boolean;
     request: HTTPIncomingMessage;
-    timeout: number;
     callbacks: any;
     socketId: string;
-    lock: AsyncLock;
-    readOnly: Boolean;
-    logger: Debugger;
+    readOnly: boolean;
     /**
      * Constructor.
      */
-    constructor(connection: WebSocket, request: HTTPIncomingMessage, document: Document, timeout: number, socketId: string, context: any, readOnly: boolean | undefined, logger: Debugger);
-    boundClose: (event?: CloseEvent) => void;
-    boundHandlePong: () => void;
-    handlePong(): void;
+    constructor(connection: WebSocket, request: HTTPIncomingMessage, document: Document, socketId: string, context: any, readOnly?: boolean);
     /**
      * Set a callback that will be triggered when the connection is closed
      */
@@ -51,11 +40,6 @@ export declare class Connection {
      * Graceful wrapper around the WebSocket close method.
      */
     close(event?: CloseEvent): void;
-    /**
-     * Check if pong was received and close the connection otherwise
-     * @private
-     */
-    private check;
     /**
      * Send the current document awareness to the client, if any
      * @private

package/dist/packages/server/src/DirectConnection.d.ts

@@ -1,4 +1,4 @@
-import Document from './Document.js';
+import type Document from './Document.js';
 import type { Hocuspocus } from './Hocuspocus.js';
 import type { DirectConnection as DirectConnectionInterface } from './types.js';
 export declare class DirectConnection implements DirectConnectionInterface {
@@ -9,6 +9,6 @@ export declare class DirectConnection implements DirectConnectionInterface {
      * Constructor.
      */
     constructor(document: Document, instance: Hocuspocus, context?: any);
-    transact(transaction: (document: Document) => void, transactionOrigin?: any): Promise<void>;
+    transact(transaction: (document: Document) => void): Promise<void>;
     disconnect(): Promise<void>;
 }

package/dist/packages/server/src/Document.d.ts

@@ -1,9 +1,7 @@
-import WebSocket from 'ws';
+import type WebSocket from 'ws';
 import { Awareness } from 'y-protocols/awareness';
 import { Doc } from 'yjs';
-import { mutex } from 'lib0/mutex.js';
-import Connection from './Connection.js';
-import { Debugger } from './Debugger.js';
+import type Connection from './Connection.js';
 export declare class Document extends Doc {
     awareness: Awareness;
     callbacks: {
@@ -16,14 +14,12 @@ export declare class Document extends Doc {
     }>;
     directConnectionsCount: number;
     name: string;
-    mux: mutex;
-    logger?: Debugger;
     isLoading: boolean;
     isDestroyed: boolean;
     /**
      * Constructor.
      */
-    constructor(name: string, logger?: Debugger, yDocOptions?: {});
+    constructor(name: string, yDocOptions?: object);
     /**
      * Check if the Document (XMLFragment or Map) is empty
      */

package/dist/packages/server/src/Hocuspocus.d.ts

@@ -1,15 +1,12 @@
 /// <reference types="node" />
-import { IncomingMessage } from 'http';
-import WebSocket, { AddressInfo } from 'ws';
-import { Server as HocuspocusServer } from './Server.js';
-import { Debugger } from './Debugger.js';
+import type { IncomingMessage } from 'http';
+import type WebSocket from 'ws';
+import type { Server } from './Server.js';
 import { DirectConnection } from './DirectConnection.js';
 import Document from './Document.js';
-import { Configuration, ConnectionConfiguration, HookName, HookPayloadByName, onListenPayload, onStoreDocumentPayload } from './types.js';
+import type { Configuration, ConnectionConfiguration, HookName, HookPayloadByName, onStoreDocumentPayload } from './types.js';
 export declare const defaultConfiguration: {
     name: null;
-    port: number;
-    address: string;
     timeout: number;
     debounce: number;
     maxDebounce: number;
@@ -19,17 +16,12 @@ export declare const defaultConfiguration: {
         gcFilter: () => boolean;
     };
     unloadImmediately: boolean;
-    stopOnSignals: boolean;
 };
-/**
- * Hocuspocus Server
- */
 export declare class Hocuspocus {
     configuration: Configuration;
     loadingDocuments: Map<string, Promise<Document>>;
     documents: Map<string, Document>;
-    server?: HocuspocusServer;
-    debugger: Debugger;
+    server?: Server;
     debouncer: {
         debounce: (id: string, func: Function, debounce: number, maxDebounce: number) => any;
         isDebounced: (id: string) => boolean;
@@ -37,19 +29,9 @@ export declare class Hocuspocus {
     };
     constructor(configuration?: Partial<Configuration>);
     /**
-     * Configure the server
+     * Configure Hocuspocus
      */
     configure(configuration: Partial<Configuration>): Hocuspocus;
-    get requiresAuthentication(): boolean;
-    /**
-     * Start the server
-     */
-    listen(portOrCallback?: number | ((data: onListenPayload) => Promise<any>) | null, callback?: any, websocketOptions?: WebSocket.ServerOptions): Promise<Hocuspocus>;
-    get address(): AddressInfo;
-    get URL(): string;
-    get webSocketURL(): string;
-    get httpURL(): string;
-    private showStartScreen;
     /**
      * Get the total number of active documents
      */
@@ -62,10 +44,6 @@ export declare class Hocuspocus {
      * Force close one or more connections
      */
     closeConnections(documentName?: string): void;
-    /**
-     * Destroy the server
-     */
-    destroy(): Promise<any>;
     /**
      * The `handleConnection` method receives incoming WebSocket connections,
      * runs all hooks:
@@ -88,7 +66,7 @@ export declare class Hocuspocus {
      * Create a new document by the given request
      */
     createDocument(documentName: string, request: Partial<Pick<IncomingMessage, 'headers' | 'url'>>, socketId: string, connection: ConnectionConfiguration, context?: any): Promise<Document>;
-    loadDocument(documentName: string, request: Partial<Pick<IncomingMessage, 'headers' | 'url'>>, socketId: string, connection: ConnectionConfiguration, context?: any): Promise<Document>;
+    loadDocument(documentName: string, request: Partial<Pick<IncomingMessage, 'headers' | 'url'>>, socketId: string, connectionConfig: ConnectionConfiguration, context?: any): Promise<Document>;
     storeDocumentHooks(document: Document, hookPayload: onStoreDocumentPayload, immediately?: boolean): any;
     /**
      * Run the given hook on all configured extensions.
@@ -96,12 +74,5 @@ export declare class Hocuspocus {
      */
     hooks<T extends HookName>(name: T, payload: HookPayloadByName[T], callback?: Function | null): Promise<any>;
     unloadDocument(document: Document): Promise<any>;
-    enableDebugging(): void;
-    enableMessageLogging(): void;
-    disableLogging(): void;
-    disableDebugging(): void;
-    flushMessageLogs(): this;
-    getMessageLogs(): any[];
     openDirectConnection(documentName: string, context?: any): Promise<DirectConnection>;
 }
-export declare const Server: Hocuspocus;

package/dist/packages/server/src/IncomingMessage.d.ts

@@ -1,6 +1,6 @@
-import { Decoder } from 'lib0/decoding';
-import { Encoder } from 'lib0/encoding';
-import { MessageType } from './types.js';
+import type { Decoder } from 'lib0/decoding';
+import type { Encoder } from 'lib0/encoding';
+import type { MessageType } from './types.js';
 export declare class IncomingMessage {
     /**
      * Access to the received message.

package/dist/packages/server/src/MessageReceiver.d.ts

@@ -1,13 +1,11 @@
-import Connection from './Connection.js';
-import { Debugger } from './Debugger.js';
-import Document from './Document.js';
-import { IncomingMessage } from './IncomingMessage.js';
+import type Connection from './Connection.js';
+import type Document from './Document.js';
+import type { IncomingMessage } from './IncomingMessage.js';
 export declare class MessageReceiver {
     message: IncomingMessage;
-    logger: Debugger;
     defaultTransactionOrigin?: string;
-    constructor(message: IncomingMessage, logger: Debugger, defaultTransactionOrigin?: string);
+    constructor(message: IncomingMessage, defaultTransactionOrigin?: string);
     apply(document: Document, connection?: Connection, reply?: (message: Uint8Array) => void): void;
-    readSyncMessage(message: IncomingMessage, document: Document, connection?: Connection, reply?: (message: Uint8Array) => void, requestFirstSync?: boolean): 0 | 2 | 1;
+    readSyncMessage(message: IncomingMessage, document: Document, connection?: Connection, reply?: (message: Uint8Array) => void, requestFirstSync?: boolean): 0 | 1 | 2;
     applyQueryAwarenessMessage(document: Document, reply?: (message: Uint8Array) => void): void;
 }

package/dist/packages/server/src/OutgoingMessage.d.ts

@@ -1,6 +1,6 @@
-import { Encoder } from 'lib0/encoding';
-import { Awareness } from 'y-protocols/awareness';
-import Document from './Document.js';
+import type { Encoder } from 'lib0/encoding';
+import type { Awareness } from 'y-protocols/awareness';
+import type Document from './Document.js';
 export declare class OutgoingMessage {
     encoder: Encoder;
     type?: number;
@@ -17,5 +17,6 @@ export declare class OutgoingMessage {
     writeStateless(payload: string): OutgoingMessage;
     writeBroadcastStateless(payload: string): OutgoingMessage;
     writeSyncStatus(updateSaved: boolean): OutgoingMessage;
+    writeCloseMessage(reason: string): OutgoingMessage;
     toUint8Array(): Uint8Array;
 }

package/dist/packages/server/src/Server.d.ts

@@ -1,13 +1,33 @@
 /// <reference types="node" />
-import { IncomingMessage, Server as HTTPServer, ServerResponse } from 'http';
-import { ServerOptions, WebSocketServer } from 'ws';
+import type { IncomingMessage, Server as HTTPServer, ServerResponse } from 'http';
+import { WebSocketServer } from 'ws';
+import type { AddressInfo, ServerOptions } from 'ws';
 import { Hocuspocus } from './Hocuspocus.js';
+import type { Configuration } from './types';
+export interface ServerConfiguration extends Configuration {
+    port?: number;
+    address?: string;
+    stopOnSignals?: boolean;
+}
+export declare const defaultServerConfiguration: {
+    port: number;
+    address: string;
+    stopOnSignals: boolean;
+};
 export declare class Server {
     httpServer: HTTPServer;
     webSocketServer: WebSocketServer;
     hocuspocus: Hocuspocus;
-    constructor(hocuspocus: Hocuspocus, websocketOptions?: ServerOptions);
+    configuration: ServerConfiguration;
+    constructor(configuration?: Partial<ServerConfiguration>, websocketOptions?: ServerOptions);
     setupWebsocketConnection: () => void;
     setupHttpUpgrade: () => void;
     requestHandler: (request: IncomingMessage, response: ServerResponse) => Promise<void>;
+    listen(port?: number, callback?: any): Promise<Hocuspocus>;
+    get address(): AddressInfo;
+    destroy(): Promise<any>;
+    get URL(): string;
+    get webSocketURL(): string;
+    get httpURL(): string;
+    private showStartScreen;
 }

package/dist/packages/server/src/index.d.ts

@@ -1,9 +1,9 @@
 export * from './Connection.js';
-export * from './Debugger.js';
 export * from './Document.js';
 export * from './Hocuspocus.js';
 export * from './IncomingMessage.js';
 export * from './MessageReceiver.js';
 export * from './OutgoingMessage.js';
+export * from './Server.js';
 export * from './types.js';
 export * from './util/debounce.js';

package/dist/packages/server/src/types.d.ts

@@ -1,12 +1,13 @@
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
-import { IncomingHttpHeaders, IncomingMessage, ServerResponse } from 'http';
-import { URLSearchParams } from 'url';
-import { Awareness } from 'y-protocols/awareness';
-import Connection from './Connection.js';
-import Document from './Document.js';
-import { Hocuspocus } from './Hocuspocus.js';
+/// <reference types="node" />
+import type { IncomingHttpHeaders, IncomingMessage, ServerResponse } from 'http';
+import type { URLSearchParams } from 'url';
+import type { Awareness } from 'y-protocols/awareness';
+import type Connection from './Connection.js';
+import type Document from './Document.js';
+import type { Hocuspocus } from './Hocuspocus.js';
 export declare enum MessageType {
     Unknown = -1,
     Sync = 0,
@@ -26,7 +27,6 @@ export interface AwarenessUpdate {
 }
 export interface ConnectionConfiguration {
     readOnly: boolean;
-    requiresAuthentication: boolean;
     isAuthenticated: boolean;
 }
 export interface Extension {
@@ -87,14 +87,6 @@ export interface Configuration extends Extension {
      * A list of hocuspocus extensions.
      */
     extensions: Array<Extension>;
-    /**
-     * The port which the server listens on.
-     */
-    port?: number;
-    /**
-     * The address which the server listens on.
-     */
-    address?: string;
     /**
      * Defines in which interval the server sends a ping, and closes the connection when no pong is sent back.
      */
@@ -120,12 +112,6 @@ export interface Configuration extends Extension {
      * your onStoreDocument is rate-limited.
      */
     unloadImmediately: boolean;
-    /**
-     * the server will gracefully stop if SIGINT, SIGQUIT or SIGTERM is received.
-     *
-     * Set this to false if you don't want that.
-     */
-    stopOnSignals: boolean;
     /**
      * options to pass to the ydoc document
      */
@@ -149,7 +135,7 @@ export interface onAuthenticatePayload {
     request: IncomingMessage;
     socketId: string;
     token: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface onCreateDocumentPayload {
     context: any;
@@ -158,7 +144,7 @@ export interface onCreateDocumentPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface onConnectPayload {
     context: any;
@@ -168,7 +154,7 @@ export interface onConnectPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface connectedPayload {
     context: any;
@@ -178,8 +164,8 @@ export interface connectedPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
-    connectionInstance: Connection;
+    connectionConfig: ConnectionConfiguration;
+    connection: Connection;
 }
 export interface onLoadDocumentPayload {
     context: any;
@@ -189,7 +175,7 @@ export interface onLoadDocumentPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface afterLoadDocumentPayload {
     context: any;
@@ -199,7 +185,7 @@ export interface afterLoadDocumentPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface onChangePayload {
     clientsCount: number;
@@ -269,7 +255,7 @@ export interface fetchPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfiguration;
+    connectionConfig: ConnectionConfiguration;
 }
 export interface storePayload extends onStoreDocumentPayload {
     state: Buffer;

package/dist/packages/server/src/util/getParameters.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 /// <reference types="node" />
-import { IncomingMessage } from 'http';
+import type { IncomingMessage } from 'http';
 import { URLSearchParams } from 'url';
 /**
    * Get parameters by the given request

package/dist/packages/transformer/src/Prosemirror.d.ts

@@ -1,6 +1,6 @@
 import { Doc } from 'yjs';
 import { Schema } from '@tiptap/pm/model';
-import { Transformer } from './types.js';
+import type { Transformer } from './types.js';
 declare class Prosemirror implements Transformer {
     defaultSchema: Schema;
     schema(schema: Schema): Prosemirror;

package/dist/packages/transformer/src/Tiptap.d.ts

@@ -1,6 +1,6 @@
-import { Doc } from 'yjs';
-import { Extensions } from '@tiptap/core';
-import { Transformer } from './types.js';
+import type { Doc } from 'yjs';
+import type { Extensions } from '@tiptap/core';
+import type { Transformer } from './types.js';
 export declare class Tiptap implements Transformer {
     defaultExtensions: Extensions;
     extensions(extensions: Extensions): Tiptap;

package/dist/packages/transformer/src/types.d.ts

@@ -1,4 +1,4 @@
-import { Doc } from 'yjs';
+import type { Doc } from 'yjs';
 export interface Transformer {
     fromYdoc: (document: Doc, fieldName?: string | Array<string>) => any;
     toYdoc: (document: any, fieldName: string) => Doc;

package/dist/tests/utils/newHocuspocus.d.ts

@@ -1,2 +1,2 @@
-import { Hocuspocus, Configuration } from '@hocuspocus/server';
-export declare const newHocuspocus: (options?: Partial<Configuration>) => Promise<Hocuspocus>;
+import type { ServerConfiguration } from '@hocuspocus/server';
+export declare const newHocuspocus: (options?: Partial<ServerConfiguration>) => Promise<import("@hocuspocus/server").Hocuspocus>;

package/dist/tests/utils/newHocuspocusProvider.d.ts

@@ -1,3 +1,3 @@
-import { HocuspocusProvider, HocuspocusProviderConfiguration, HocuspocusProviderWebsocket, HocuspocusProviderWebsocketConfiguration } from '@hocuspocus/provider';
-import { Hocuspocus } from '@hocuspocus/server';
+import { HocuspocusProvider, type HocuspocusProviderConfiguration, type HocuspocusProviderWebsocket, type HocuspocusProviderWebsocketConfiguration } from '@hocuspocus/provider';
+import type { Hocuspocus } from '@hocuspocus/server';
 export declare const newHocuspocusProvider: (server: Hocuspocus, options?: Partial<HocuspocusProviderConfiguration>, websocketOptions?: Partial<HocuspocusProviderWebsocketConfiguration>, websocketProvider?: HocuspocusProviderWebsocket) => HocuspocusProvider;

package/dist/tests/utils/newHocuspocusProviderWebsocket.d.ts

@@ -1,3 +1,4 @@
-import { HocuspocusProviderWebsocket, HocuspocusProviderWebsocketConfiguration } from '@hocuspocus/provider';
-import { Hocuspocus } from '@hocuspocus/server';
-export declare const newHocuspocusProviderWebsocket: (server: Hocuspocus, options?: Partial<Omit<HocuspocusProviderWebsocketConfiguration, 'url'>>) => HocuspocusProviderWebsocket;
+import type { HocuspocusProviderWebsocketConfiguration } from '@hocuspocus/provider';
+import { HocuspocusProviderWebsocket } from '@hocuspocus/provider';
+import type { Hocuspocus } from '@hocuspocus/server';
+export declare const newHocuspocusProviderWebsocket: (hocuspocus: Hocuspocus, options?: Partial<Omit<HocuspocusProviderWebsocketConfiguration, 'url'>>) => HocuspocusProviderWebsocket;

package/dist/tests/utils/retryableAssertion.d.ts

@@ -1,2 +1,2 @@
-import { ExecutionContext } from 'ava';
+import type { ExecutionContext } from 'ava';
 export declare const retryableAssertion: (t: ExecutionContext, recoverableTry: (tt: ExecutionContext) => void) => Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/extension-webhook",
-  "version": "2.15.2",
+  "version": "3.0.4-rc.0",
   "description": "hocuspocus webhook extension",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -30,9 +30,9 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/common": "^2.15.2",
-    "@hocuspocus/server": "^2.15.2",
-    "@hocuspocus/transformer": "^2.15.2",
+    "@hocuspocus/common": "^3.0.4-rc.0",
+    "@hocuspocus/server": "^3.0.4-rc.0",
+    "@hocuspocus/transformer": "^3.0.4-rc.0",
     "axios": "^1.6.2"
   },
   "peerDependencies": {

package/src/index.ts

@@ -1,13 +1,14 @@
 import { createHmac } from 'crypto'
-import {
+import type {
   Extension,
   onChangePayload,
   onConnectPayload,
   onLoadDocumentPayload,
   onDisconnectPayload,
 } from '@hocuspocus/server'
-import { Doc } from 'yjs'
-import { TiptapTransformer, Transformer } from '@hocuspocus/transformer'
+import type { Doc } from 'yjs'
+import type { Transformer } from '@hocuspocus/transformer'
+import { TiptapTransformer } from '@hocuspocus/transformer'
 import axios from 'axios'
 import { Forbidden } from '@hocuspocus/common'
 
@@ -71,6 +72,7 @@ export class Webhook implements Extension {
   /**
    * debounce the given function, using the given identifier
    */
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
   debounce(id: string, func: Function) {
     const old = this.debounced.get(id)
     const start = old?.start || Date.now()