@hocuspocus/common 3.1.2 → 3.1.4

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

@@ -1,16 +1,16 @@
-import type { Encoder } from 'lib0/encoding';
-import type { Event, MessageEvent } from 'ws';
-import type { Awareness } from 'y-protocols/awareness';
-import type * as Y from 'yjs';
-import type { CloseEvent } from '@hocuspocus/common';
-import type { IncomingMessage } from './IncomingMessage.ts';
-import type { OutgoingMessage } from './OutgoingMessage.ts';
-import type { AuthenticationMessage } from './OutgoingMessages/AuthenticationMessage.ts';
-import type { AwarenessMessage } from './OutgoingMessages/AwarenessMessage.ts';
-import type { QueryAwarenessMessage } from './OutgoingMessages/QueryAwarenessMessage.ts';
-import type { SyncStepOneMessage } from './OutgoingMessages/SyncStepOneMessage.ts';
-import type { SyncStepTwoMessage } from './OutgoingMessages/SyncStepTwoMessage.ts';
-import type { UpdateMessage } from './OutgoingMessages/UpdateMessage.ts';
+import type { Encoder } from "lib0/encoding";
+import type { Event, MessageEvent } from "ws";
+import type { Awareness } from "y-protocols/awareness";
+import type * as Y from "yjs";
+import type { CloseEvent } from "@hocuspocus/common";
+import type { IncomingMessage } from "./IncomingMessage.ts";
+import type { OutgoingMessage } from "./OutgoingMessage.ts";
+import type { AuthenticationMessage } from "./OutgoingMessages/AuthenticationMessage.ts";
+import type { AwarenessMessage } from "./OutgoingMessages/AwarenessMessage.ts";
+import type { QueryAwarenessMessage } from "./OutgoingMessages/QueryAwarenessMessage.ts";
+import type { SyncStepOneMessage } from "./OutgoingMessages/SyncStepOneMessage.ts";
+import type { SyncStepTwoMessage } from "./OutgoingMessages/SyncStepTwoMessage.ts";
+import type { UpdateMessage } from "./OutgoingMessages/UpdateMessage.ts";
 export declare enum MessageType {
     Sync = 0,
     Awareness = 1,
@@ -50,7 +50,7 @@ export type onAuthenticationFailedParameters = {
     reason: string;
 };
 export type onAuthenticatedParameters = {
-    scope: 'read-write' | 'readonly';
+    scope: "read-write" | "readonly";
 };
 export type onOpenParameters = {
     event: Event;

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

@@ -1,9 +1,9 @@
-import type { IncomingMessage } from 'http';
-import { type CloseEvent } from '@hocuspocus/common';
-import type WebSocket from 'ws';
-import type Document from './Document.ts';
-import type { Hocuspocus } from './Hocuspocus.ts';
-import type { onDisconnectPayload } from './types.ts';
+import type { IncomingMessage } from "http";
+import { type CloseEvent } from "@hocuspocus/common";
+import type WebSocket from "ws";
+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
  *
@@ -27,18 +27,18 @@ export declare class ClientConnection {
     pingInterval: NodeJS.Timeout;
     pongReceived: boolean;
     /**
-      * The `ClientConnection` class receives incoming WebSocket connections,
-      * runs all hooks:
-      *
-      *  - onConnect for all connections
-      *  - onAuthenticate only if required
-      *
-      * … and if nothings fails it’ll fully establish the connection and
-      * load the Document then.
-      */
+     * The `ClientConnection` class receives incoming WebSocket connections,
+     * runs all hooks:
+     *
+     *  - onConnect for all connections
+     *  - onAuthenticate only if required
+     *
+     * … and if nothings fails it’ll fully establish the connection and
+     * load the Document then.
+     */
     constructor(websocket: WebSocket, request: IncomingMessage, documentProvider: {
-        createDocument: Hocuspocus['createDocument'];
-    }, hooks: Hocuspocus['hooks'], opts: {
+        createDocument: Hocuspocus["createDocument"];
+    }, hooks: Hocuspocus["hooks"], opts: {
         timeout: number;
     }, defaultContext?: any);
     private handleWebsocketClose;

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

@@ -1,8 +1,8 @@
-import type { IncomingMessage as HTTPIncomingMessage } from 'http';
-import { type CloseEvent } from '@hocuspocus/common';
-import type WebSocket from 'ws';
-import type Document from './Document.ts';
-import type { beforeSyncPayload, onStatelessPayload } from './types.ts';
+import type { IncomingMessage as HTTPIncomingMessage } from "http";
+import { type CloseEvent } from "@hocuspocus/common";
+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;
@@ -35,7 +35,7 @@ export declare class 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;
+    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.ts';
-import type { Hocuspocus } from './Hocuspocus.ts';
-import type { DirectConnection as DirectConnectionInterface } from './types.ts';
+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.ts';
+import type WebSocket from "ws";
+import { Awareness } from "y-protocols/awareness";
+import { Doc } from "yjs";
+import type Connection from "./Connection.ts";
 export declare class Document extends Doc {
     awareness: Awareness;
     callbacks: {

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

@@ -1,9 +1,9 @@
-import type { IncomingMessage } from 'http';
-import type WebSocket from 'ws';
-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';
+import type { IncomingMessage } from "http";
+import type WebSocket from "ws";
+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;
@@ -64,8 +64,8 @@ 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, connectionConfig: ConnectionConfiguration, context?: any): Promise<Document>;
+    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, connectionConfig: ConnectionConfiguration, context?: any): Promise<Document>;
     storeDocumentHooks(document: Document, hookPayload: onStoreDocumentPayload, immediately?: boolean): any;
     /**
      * Run the given hook on all configured extensions.

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.ts';
+import type { Decoder } from "lib0/decoding";
+import type { Encoder } from "lib0/encoding";
+import type { MessageType } from "./types.ts";
 export declare class IncomingMessage {
     /**
      * Access to the received message.

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

@@ -1,6 +1,6 @@
-import type Connection from './Connection.ts';
-import type Document from './Document.ts';
-import type { IncomingMessage } from './IncomingMessage.ts';
+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;

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.ts';
+import type { Encoder } from "lib0/encoding";
+import type { Awareness } from "y-protocols/awareness";
+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,8 @@
-import type { IncomingMessage, Server as HTTPServer, ServerResponse } from 'http';
-import { WebSocketServer } from 'ws';
-import type { AddressInfo, ServerOptions } from 'ws';
-import { Hocuspocus } from './Hocuspocus.ts';
-import type { Configuration } from './types.ts';
+import type { Server as HTTPServer, IncomingMessage, ServerResponse } from "http";
+import { WebSocketServer } from "ws";
+import type { AddressInfo, ServerOptions } from "ws";
+import { Hocuspocus } from "./Hocuspocus.ts";
+import type { Configuration } from "./types.ts";
 export interface ServerConfiguration extends Configuration {
     port?: number;
     address?: string;

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

@@ -1,9 +1,9 @@
-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';
+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,9 +1,9 @@
-import type { IncomingHttpHeaders, IncomingMessage, ServerResponse } from 'http';
-import type { URLSearchParams } from 'url';
-import type { Awareness } from 'y-protocols/awareness';
-import type Connection from './Connection.ts';
-import type Document from './Document.ts';
-import type { Hocuspocus } from './Hocuspocus.ts';
+import type { IncomingHttpHeaders, IncomingMessage, ServerResponse } from "http";
+import type { URLSearchParams } from "url";
+import type { Awareness } from "y-protocols/awareness";
+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,
@@ -51,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' | 'beforeSync' | '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;

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

@@ -1,6 +1,6 @@
-import type { IncomingMessage } from 'http';
-import { URLSearchParams } from 'url';
+import type { IncomingMessage } from "http";
+import { URLSearchParams } from "url";
 /**
-   * Get parameters by the given request
-   */
-export declare function getParameters(request?: Pick<IncomingMessage, 'url'>): URLSearchParams;
+ * Get parameters by the given request
+ */
+export declare function getParameters(request?: Pick<IncomingMessage, "url">): URLSearchParams;

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.ts';
+import { Doc } from "yjs";
+import { Schema } from "@tiptap/pm/model";
+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.ts';
+import type { Doc } from "yjs";
+import type { Extensions } from "@tiptap/core";
+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.ts';
-export * from './Tiptap.ts';
-export * from './types.ts';
+export * from "./Prosemirror.ts";
+export * from "./Tiptap.ts";
+export * from "./types.ts";

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

@@ -1,4 +1,4 @@
-import type { 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/playground/frontend/app/SocketContext1.d.ts

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

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

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

package/package.json

@@ -1,32 +1,32 @@
 {
-  "name": "@hocuspocus/common",
-  "description": "shared code for multiple Hocuspocus packages",
-  "version": "3.1.2",
-  "homepage": "https://hocuspocus.dev",
-  "keywords": [
-    "hocuspocus"
-  ],
-  "license": "MIT",
-  "type": "module",
-  "main": "dist/hocuspocus-common.cjs",
-  "module": "dist/hocuspocus-common.esm.js",
-  "types": "dist/packages/common/src/index.d.ts",
-  "exports": {
-    "source": {
-      "import": "./src/index.ts"
-    },
-    "default": {
-      "import": "./dist/hocuspocus-common.esm.js",
-      "require": "./dist/hocuspocus-common.cjs",
-      "types": "./dist/packages/common/src/index.d.ts"
-    }
-  },
-  "files": [
-    "src",
-    "dist"
-  ],
-  "gitHead": "cd788b6a315f608ef531524409abdce1e6790726",
-  "dependencies": {
-    "lib0": "^0.2.87"
-  }
+	"name": "@hocuspocus/common",
+	"description": "shared code for multiple Hocuspocus packages",
+	"version": "3.1.4",
+	"homepage": "https://hocuspocus.dev",
+	"keywords": [
+		"hocuspocus"
+	],
+	"license": "MIT",
+	"type": "module",
+	"main": "dist/hocuspocus-common.cjs",
+	"module": "dist/hocuspocus-common.esm.js",
+	"types": "dist/packages/common/src/index.d.ts",
+	"exports": {
+		"source": {
+			"import": "./src/index.ts"
+		},
+		"default": {
+			"import": "./dist/hocuspocus-common.esm.js",
+			"require": "./dist/hocuspocus-common.cjs",
+			"types": "./dist/packages/common/src/index.d.ts"
+		}
+	},
+	"files": [
+		"src",
+		"dist"
+	],
+	"gitHead": "cd788b6a315f608ef531524409abdce1e6790726",
+	"dependencies": {
+		"lib0": "^0.2.87"
+	}
 }

package/src/CloseEvents.ts

@@ -1,6 +1,6 @@
 export interface CloseEvent {
-  code: number,
-  reason: string,
+	code: number;
+	reason: string;
 }
 
 /**
@@ -9,41 +9,41 @@ export interface CloseEvent {
  * See: https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent/code
  */
 export const MessageTooBig: CloseEvent = {
-  code: 1009,
-  reason: 'Message Too Big',
-}
+	code: 1009,
+	reason: "Message Too Big",
+};
 
 /**
  * The server successfully processed the request, asks that the requester reset
  * its document view, and is not returning any content.
  */
 export const ResetConnection: CloseEvent = {
-  code: 4205,
-  reason: 'Reset Connection',
-}
+	code: 4205,
+	reason: "Reset Connection",
+};
 
 /**
  * Similar to Forbidden, but specifically for use when authentication is required and has
  * failed or has not yet been provided.
  */
 export const Unauthorized: CloseEvent = {
-  code: 4401,
-  reason: 'Unauthorized',
-}
+	code: 4401,
+	reason: "Unauthorized",
+};
 
 /**
  * The request contained valid data and was understood by the server, but the server
  * is refusing action.
  */
 export const Forbidden: CloseEvent = {
-  code: 4403,
-  reason: 'Forbidden',
-}
+	code: 4403,
+	reason: "Forbidden",
+};
 
 /**
  * The server timed out waiting for the request.
  */
 export const ConnectionTimeout: CloseEvent = {
-  code: 4408,
-  reason: 'Connection Timeout',
-}
+	code: 4408,
+	reason: "Connection Timeout",
+};

package/src/auth.ts

@@ -1,41 +1,50 @@
-import * as encoding from 'lib0/encoding'
-import * as decoding from 'lib0/decoding'
+import * as encoding from "lib0/encoding";
+import * as decoding from "lib0/decoding";
 
 enum AuthMessageType {
-  Token = 0,
-  PermissionDenied = 1,
-  Authenticated = 2,
+	Token = 0,
+	PermissionDenied = 1,
+	Authenticated = 2,
 }
 
-export const writeAuthentication = (encoder: encoding.Encoder, auth: string) => {
-  encoding.writeVarUint(encoder, AuthMessageType.Token)
-  encoding.writeVarString(encoder, auth)
-}
+export const writeAuthentication = (
+	encoder: encoding.Encoder,
+	auth: string,
+) => {
+	encoding.writeVarUint(encoder, AuthMessageType.Token);
+	encoding.writeVarString(encoder, auth);
+};
 
-export const writePermissionDenied = (encoder: encoding.Encoder, reason: string) => {
-  encoding.writeVarUint(encoder, AuthMessageType.PermissionDenied)
-  encoding.writeVarString(encoder, reason)
-}
+export const writePermissionDenied = (
+	encoder: encoding.Encoder,
+	reason: string,
+) => {
+	encoding.writeVarUint(encoder, AuthMessageType.PermissionDenied);
+	encoding.writeVarString(encoder, reason);
+};
 
-export const writeAuthenticated = (encoder: encoding.Encoder, scope: 'readonly' | 'read-write') => {
-  encoding.writeVarUint(encoder, AuthMessageType.Authenticated)
-  encoding.writeVarString(encoder, scope)
-}
+export const writeAuthenticated = (
+	encoder: encoding.Encoder,
+	scope: "readonly" | "read-write",
+) => {
+	encoding.writeVarUint(encoder, AuthMessageType.Authenticated);
+	encoding.writeVarString(encoder, scope);
+};
 
 export const readAuthMessage = (
-  decoder: decoding.Decoder,
-  permissionDeniedHandler: (reason: string) => void,
-  authenticatedHandler: (scope: string) => void,
+	decoder: decoding.Decoder,
+	permissionDeniedHandler: (reason: string) => void,
+	authenticatedHandler: (scope: string) => void,
 ) => {
-  switch (decoding.readVarUint(decoder)) {
-    case AuthMessageType.PermissionDenied: {
-      permissionDeniedHandler(decoding.readVarString(decoder))
-      break
-    }
-    case AuthMessageType.Authenticated: {
-      authenticatedHandler(decoding.readVarString(decoder))
-      break
-    }
-    default:
-  }
-}
+	switch (decoding.readVarUint(decoder)) {
+		case AuthMessageType.PermissionDenied: {
+			permissionDeniedHandler(decoding.readVarString(decoder));
+			break;
+		}
+		case AuthMessageType.Authenticated: {
+			authenticatedHandler(decoding.readVarString(decoder));
+			break;
+		}
+		default:
+	}
+};

package/src/awarenessStatesToArray.ts

@@ -1,8 +1,10 @@
-export const awarenessStatesToArray = (states: Map<number, Record<string, any>>) => {
-  return Array.from(states.entries()).map(([key, value]) => {
-    return {
-      clientId: key,
-      ...value,
-    }
-  })
-}
+export const awarenessStatesToArray = (
+	states: Map<number, Record<string, any>>,
+) => {
+	return Array.from(states.entries()).map(([key, value]) => {
+		return {
+			clientId: key,
+			...value,
+		};
+	});
+};

package/src/index.ts

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

package/src/types.ts

@@ -3,8 +3,8 @@
  * https://developer.mozilla.org/de/docs/Web/API/WebSocket/readyState
  */
 export enum WsReadyStates {
-  Connecting = 0,
-  Open = 1,
-  Closing = 2,
-  Closed = 3,
+	Connecting = 0,
+	Open = 1,
+	Closing = 2,
+	Closed = 3,
 }

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

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