@hocuspocus/common 3.0.4-rc.0 → 3.0.6-rc.0

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

@@ -1,11 +1,9 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import type { IncomingMessage } from 'http';
 import { type CloseEvent } from '@hocuspocus/common';
 import type WebSocket from 'ws';
-import type Document from './Document.js';
-import type { Hocuspocus } from './Hocuspocus.js';
-import type { onDisconnectPayload } from './types.js';
+import type Document from './Document.ts';
+import type { Hocuspocus } from './Hocuspocus.ts';
+import type { onDisconnectPayload } from './types.ts';
 /**
  * The `ClientConnection` class is responsible for handling an incoming WebSocket
  *

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

@@ -1,15 +1,19 @@
-/// <reference types="node" />
 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';
+import type WebSocket from 'ws';
+import type Document from './Document.ts';
+import type { beforeSyncPayload, onStatelessPayload } from './types.ts';
 export declare class Connection {
     webSocket: WebSocket;
     context: any;
     document: Document;
     request: HTTPIncomingMessage;
-    callbacks: any;
+    callbacks: {
+        onClose: ((document: Document, event?: CloseEvent) => void)[];
+        beforeHandleMessage: (connection: Connection, update: Uint8Array) => Promise<void>;
+        beforeSync: (connection: Connection, payload: Pick<beforeSyncPayload, "type" | "payload">) => Promise<void>;
+        statelessCallback: (payload: onStatelessPayload) => Promise<void>;
+    };
     socketId: string;
     readOnly: boolean;
     /**
@@ -28,6 +32,10 @@ export declare class Connection {
      * Set a callback that will be triggered before an message is handled
      */
     beforeHandleMessage(callback: (connection: Connection, update: Uint8Array) => Promise<any>): Connection;
+    /**
+     * Set a callback that will be triggered before a sync message is handled
+     */
+    beforeSync(callback: (connection: Connection, payload: Pick<beforeSyncPayload, 'type' | 'payload'>) => Promise<any>): Connection;
     /**
      * Send the given message
      */

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

@@ -1,6 +1,6 @@
-import type Document from './Document.js';
-import type { Hocuspocus } from './Hocuspocus.js';
-import type { DirectConnection as DirectConnectionInterface } from './types.js';
+import type Document from './Document.ts';
+import type { Hocuspocus } from './Hocuspocus.ts';
+import type { DirectConnection as DirectConnectionInterface } from './types.ts';
 export declare class DirectConnection implements DirectConnectionInterface {
     document: Document | null;
     instance: Hocuspocus;

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

@@ -1,7 +1,7 @@
 import type WebSocket from 'ws';
 import { Awareness } from 'y-protocols/awareness';
 import { Doc } from 'yjs';
-import type Connection from './Connection.js';
+import type Connection from './Connection.ts';
 export declare class Document extends Doc {
     awareness: Awareness;
     callbacks: {

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

@@ -1,10 +1,9 @@
-/// <reference types="node" />
 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 type { Configuration, ConnectionConfiguration, HookName, HookPayloadByName, onStoreDocumentPayload } from './types.js';
+import { DirectConnection } from './DirectConnection.ts';
+import Document from './Document.ts';
+import type { Server } from './Server.ts';
+import type { Configuration, ConnectionConfiguration, HookName, HookPayloadByName, onStoreDocumentPayload } from './types.ts';
 export declare const defaultConfiguration: {
     name: null;
     timeout: number;

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

@@ -1,6 +1,6 @@
 import type { Decoder } from 'lib0/decoding';
 import type { Encoder } from 'lib0/encoding';
-import type { MessageType } from './types.js';
+import type { MessageType } from './types.ts';
 export declare class IncomingMessage {
     /**
      * Access to the received message.
@@ -14,10 +14,11 @@ export declare class IncomingMessage {
     private encoderInternal?;
     constructor(input: any);
     get encoder(): Encoder;
-    readVarUint8Array(): Uint8Array;
+    readVarUint8Array(): Uint8Array<ArrayBufferLike>;
+    peekVarUint8Array(): Uint8Array<ArrayBufferLike>;
     readVarUint(): number;
     readVarString(): string;
-    toUint8Array(): Uint8Array;
+    toUint8Array(): Uint8Array<ArrayBufferLike>;
     writeVarUint(type: MessageType): void;
     writeVarString(string: string): void;
     get length(): number;

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

@@ -1,11 +1,11 @@
-import type Connection from './Connection.js';
-import type Document from './Document.js';
-import type { IncomingMessage } from './IncomingMessage.js';
+import type Connection from './Connection.ts';
+import type Document from './Document.ts';
+import type { IncomingMessage } from './IncomingMessage.ts';
 export declare class MessageReceiver {
     message: IncomingMessage;
     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 | 1 | 2;
+    apply(document: Document, connection?: Connection, reply?: (message: Uint8Array) => void): Promise<void>;
+    readSyncMessage(message: IncomingMessage, document: Document, connection?: Connection, reply?: (message: Uint8Array) => void, requestFirstSync?: boolean): Promise<0 | 1 | 2>;
     applyQueryAwarenessMessage(document: Document, reply?: (message: Uint8Array) => void): void;
 }

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

@@ -1,6 +1,6 @@
 import type { Encoder } from 'lib0/encoding';
 import type { Awareness } from 'y-protocols/awareness';
-import type Document from './Document.js';
+import type Document from './Document.ts';
 export declare class OutgoingMessage {
     encoder: Encoder;
     type?: number;

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

@@ -1,8 +1,7 @@
-/// <reference types="node" />
 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 { Hocuspocus } from './Hocuspocus.ts';
 import type { Configuration } from './types';
 export interface ServerConfiguration extends Configuration {
     port?: number;

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

@@ -1,9 +1,9 @@
-export * from './Connection.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';
+export * from './Connection.ts';
+export * from './Document.ts';
+export * from './Hocuspocus.ts';
+export * from './IncomingMessage.ts';
+export * from './MessageReceiver.ts';
+export * from './OutgoingMessage.ts';
+export * from './Server.ts';
+export * from './types.ts';
+export * from './util/debounce.ts';

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

@@ -1,20 +1,16 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-/// <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';
+import type Connection from './Connection.ts';
+import type Document from './Document.ts';
+import type { Hocuspocus } from './Hocuspocus.ts';
 export declare enum MessageType {
     Unknown = -1,
     Sync = 0,
     Awareness = 1,
     Auth = 2,
     QueryAwareness = 3,
-    SyncReply = 4,
+    SyncReply = 4,// same as Sync, but won't trigger another 'SyncStep1'
     Stateless = 5,
     BroadcastStateless = 6,
     CLOSE = 7,
@@ -42,6 +38,7 @@ export interface Extension {
     onLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
     afterLoadDocument?(data: afterLoadDocumentPayload): Promise<any>;
     beforeHandleMessage?(data: beforeHandleMessagePayload): Promise<any>;
+    beforeSync?(data: beforeSyncPayload): Promise<any>;
     beforeBroadcastStateless?(data: beforeBroadcastStatelessPayload): Promise<any>;
     onStateless?(payload: onStatelessPayload): Promise<any>;
     onChange?(data: onChangePayload): Promise<any>;
@@ -54,7 +51,7 @@ export interface Extension {
     afterUnloadDocument?(data: afterUnloadDocumentPayload): Promise<any>;
     onDestroy?(data: onDestroyPayload): Promise<any>;
 }
-export type HookName = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 'onCreateDocument' | 'onLoadDocument' | 'afterLoadDocument' | 'beforeHandleMessage' | 'beforeBroadcastStateless' | 'onStateless' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'beforeUnloadDocument' | 'afterUnloadDocument' | 'onDestroy';
+export type HookName = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 'onCreateDocument' | 'onLoadDocument' | 'afterLoadDocument' | 'beforeHandleMessage' | 'beforeBroadcastStateless' | 'beforeSync' | 'onStateless' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'beforeUnloadDocument' | 'afterUnloadDocument' | 'onDestroy';
 export type HookPayloadByName = {
     onConfigure: onConfigurePayload;
     onListen: onListenPayload;
@@ -67,6 +64,7 @@ export type HookPayloadByName = {
     afterLoadDocument: afterLoadDocumentPayload;
     beforeHandleMessage: beforeHandleMessagePayload;
     beforeBroadcastStateless: beforeBroadcastStatelessPayload;
+    beforeSync: beforeSyncPayload;
     onStateless: onStatelessPayload;
     onChange: onChangePayload;
     onStoreDocument: onStoreDocumentPayload;
@@ -211,6 +209,27 @@ export interface beforeHandleMessagePayload {
     socketId: string;
     connection: Connection;
 }
+export interface beforeSyncPayload {
+    clientsCount: number;
+    context: any;
+    document: Document;
+    documentName: string;
+    connection: Connection;
+    /**
+     * The y-protocols/sync message type
+     * @example
+     * 0: SyncStep1
+     * 1: SyncStep2
+     * 2: YjsUpdate
+     *
+     * @see https://github.com/yjs/y-protocols/blob/master/sync.js#L13-L40
+     */
+    type: number;
+    /**
+     * The payload of the y-sync message.
+     */
+    payload: Uint8Array;
+}
 export interface beforeBroadcastStatelessPayload {
     document: Document;
     documentName: string;

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

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import type { IncomingMessage } from 'http';
 import { URLSearchParams } from 'url';
 /**

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

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

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

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

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

@@ -1,3 +1,3 @@
-export * from './Prosemirror.js';
-export * from './Tiptap.js';
-export * from './types.js';
+export * from './Prosemirror.ts';
+export * from './Tiptap.ts';
+export * from './types.ts';

package/dist/playground/frontend/app/SocketContext.d.ts

@@ -0,0 +1,2 @@
+import type { HocuspocusProviderWebsocket } from "@hocuspocus/provider";
+export declare const SocketContext: import("react").Context<HocuspocusProviderWebsocket | null>;

package/dist/playground/frontend/next.config.d.ts

@@ -0,0 +1,3 @@
+import type { NextConfig } from "next";
+declare const nextConfig: NextConfig;
+export default nextConfig;

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

@@ -1,9 +1,9 @@
-export * from './createDirectory.js';
-export * from './flushRedis.js';
-export * from './newHocuspocus.js';
-export * from './newHocuspocusProvider.js';
-export * from './newHocuspocusProviderWebsocket.js';
-export * from './randomInteger.js';
-export * from './redisConnectionSettings.js';
-export * from './removeDirectory.js';
-export * from './sleep.js';
+export * from './createDirectory.ts';
+export * from './flushRedis.ts';
+export * from './newHocuspocus.ts';
+export * from './newHocuspocusProvider.ts';
+export * from './newHocuspocusProviderWebsocket.ts';
+export * from './randomInteger.ts';
+export * from './redisConnectionSettings.ts';
+export * from './removeDirectory.ts';
+export * from './sleep.ts';

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

@@ -1,4 +1,4 @@
 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;
+export declare const newHocuspocusProviderWebsocket: (hocuspocus: Hocuspocus, options?: Partial<Omit<HocuspocusProviderWebsocketConfiguration, "url">>) => HocuspocusProviderWebsocket;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hocuspocus/common",
   "description": "shared code for multiple Hocuspocus packages",
-  "version": "3.0.4-rc.0",
+  "version": "3.0.6-rc.0",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
     "hocuspocus"
@@ -13,7 +13,7 @@
   "types": "dist/packages/common/src/index.d.ts",
   "exports": {
     "source": {
-      "import": "./src"
+      "import": "./src/index.ts"
     },
     "default": {
       "import": "./dist/hocuspocus-common.esm.js",

package/src/index.ts

@@ -1,4 +1,4 @@
-export * from './auth.js'
-export * from './CloseEvents.js'
-export * from './awarenessStatesToArray.js'
-export * from './types.js'
+export * from './auth.ts'
+export * from './CloseEvents.ts'
+export * from './awarenessStatesToArray.ts'
+export * from './types.ts'

package/dist/playground/frontend/vite.config.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("vite").UserConfig;
-export default _default;