@hocuspocus/common 2.11.3 → 2.12.1-rc.0

package/README.md

@@ -7,7 +7,7 @@
 ## Introduction
 Hocuspocus is an opinionated collaborative editing backend for [Tiptap](https://github.com/ueberdosis/tiptap) – based on [Y.js](https://github.com/yjs/yjs), a CRDT framework with a powerful abstraction of shared data.
 
-## Offical Documentation
+## Official Documentation
 Documentation can be found in the [GitHub repository](https://github.com/ueberdosis/hocuspocus).
 
 ## License

package/dist/packages/extension-redis/src/Redis.d.ts

@@ -110,7 +110,7 @@ export declare class Redis implements Extension {
     onChange(data: onChangePayload): Promise<any>;
     /**
      * Make sure to *not* listen for further changes, when there’s
-     * noone connected anymore.
+     * no one connected anymore.
      */
     onDisconnect: ({ documentName }: onDisconnectPayload) => Promise<void>;
     beforeBroadcastStateless(data: beforeBroadcastStatelessPayload): Promise<number>;

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

@@ -35,7 +35,7 @@ export interface CompleteHocuspocusProviderWebsocketConfiguration {
      */
     delay: number;
     /**
-     * The intialDelay is the amount of time to wait before making the first attempt. This option should typically be 0 since you typically want the first attempt to happen immediately.
+     * The initialDelay is the amount of time to wait before making the first attempt. This option should typically be 0 since you typically want the first attempt to happen immediately.
      */
     initialDelay: number;
     /**

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

@@ -113,7 +113,7 @@ export type THistoryAction = THistoryDocumentRevertAction | THistoryVersionCreat
 export type THistoryDocumentRevertAction = {
     action: 'document.revert';
     /**
-     * if changes havent been persisted to a version yet, we'll create one with the specified name,
+     * if changes haven't been persisted to a version yet, we'll create one with the specified name,
      * expect when `false` is passed.
      */
     currentVersionName?: string | false;

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

@@ -38,6 +38,7 @@ export interface Extension {
     onConnect?(data: onConnectPayload): Promise<any>;
     connected?(data: connectedPayload): Promise<any>;
     onAuthenticate?(data: onAuthenticatePayload): Promise<any>;
+    onCreateDocument?(data: onCreateDocumentPayload): Promise<any>;
     onLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
     afterLoadDocument?(data: afterLoadDocumentPayload): Promise<any>;
     beforeHandleMessage?(data: beforeHandleMessagePayload): Promise<any>;
@@ -52,7 +53,7 @@ export interface Extension {
     afterUnloadDocument?(data: afterUnloadDocumentPayload): Promise<any>;
     onDestroy?(data: onDestroyPayload): Promise<any>;
 }
-export type HookName = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 'onLoadDocument' | 'afterLoadDocument' | 'beforeHandleMessage' | 'beforeBroadcastStateless' | 'onStateless' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'afterUnloadDocument' | 'onDestroy';
+export type HookName = 'onConfigure' | 'onListen' | 'onUpgrade' | 'onConnect' | 'connected' | 'onAuthenticate' | 'onCreateDocument' | 'onLoadDocument' | 'afterLoadDocument' | 'beforeHandleMessage' | 'beforeBroadcastStateless' | 'onStateless' | 'onChange' | 'onStoreDocument' | 'afterStoreDocument' | 'onAwarenessUpdate' | 'onRequest' | 'onDisconnect' | 'afterUnloadDocument' | 'onDestroy';
 export type HookPayloadByName = {
     onConfigure: onConfigurePayload;
     onListen: onListenPayload;
@@ -60,6 +61,7 @@ export type HookPayloadByName = {
     onConnect: onConnectPayload;
     connected: connectedPayload;
     onAuthenticate: onAuthenticatePayload;
+    onCreateDocument: onCreateDocumentPayload;
     onLoadDocument: onLoadDocumentPayload;
     afterLoadDocument: afterLoadDocumentPayload;
     beforeHandleMessage: beforeHandleMessagePayload;
@@ -80,7 +82,7 @@ export interface Configuration extends Extension {
      */
     name: string | null;
     /**
-     * A list of hocuspocus extenions.
+     * A list of hocuspocus extensions.
      */
     extensions: Array<Extension>;
     /**
@@ -142,10 +144,20 @@ export interface onAuthenticatePayload {
     instance: Hocuspocus;
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
+    request: IncomingMessage;
     socketId: string;
     token: string;
     connection: ConnectionConfiguration;
 }
+export interface onCreateDocumentPayload {
+    context: any;
+    documentName: string;
+    instance: Hocuspocus;
+    requestHeaders: IncomingHttpHeaders;
+    requestParameters: URLSearchParams;
+    socketId: string;
+    connection: ConnectionConfiguration;
+}
 export interface onConnectPayload {
     context: any;
     documentName: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hocuspocus/common",
   "description": "shared code for multiple Hocuspocus packages",
-  "version": "2.11.3",
+  "version": "2.12.1-rc.0",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
     "hocuspocus"