@hocuspocus/provider 1.0.0-alpha.18 → 1.0.0-alpha.22

package/dist/packages/extension-logger/src/Logger.d.ts

@@ -0,0 +1,68 @@
+import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDestroyPayload, onDisconnectPayload, onListenPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
+export interface LoggerConfiguration {
+    /**
+     * Prepend all logging message with a string.
+     *
+     * @deprecated
+     */
+    prefix: null | string;
+    /**
+     * Whether to log something for the `onLoadDocument` hook.
+     */
+    onLoadDocument: boolean;
+    /**
+     * Whether to log something for the `onChange` hook.
+     */
+    onChange: boolean;
+    /**
+     * Whether to log something for the `onConnect` hook.
+     */
+    onConnect: boolean;
+    /**
+     * Whether to log something for the `onDisconnect` hook.
+     */
+    onDisconnect: boolean;
+    /**
+     * Whether to log something for the `onUpgrade` hook.
+     */
+    onUpgrade: boolean;
+    /**
+     * Whether to log something for the `onRequest` hook.
+     */
+    onRequest: boolean;
+    /**
+     * Whether to log something for the `onListen` hook.
+     */
+    onListen: boolean;
+    /**
+     * Whether to log something for the `onDestroy` hook.
+     */
+    onDestroy: boolean;
+    /**
+     * Whether to log something for the `onConfigure` hook.
+     */
+    onConfigure: boolean;
+    /**
+     * A log function, if none is provided output will go to console
+     */
+    log: (...args: any[]) => void;
+}
+export declare class Logger implements Extension {
+    name: string | null;
+    configuration: LoggerConfiguration;
+    /**
+     * Constructor
+     */
+    constructor(configuration?: Partial<LoggerConfiguration>);
+    onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
+    onChange(data: onChangePayload): Promise<void>;
+    onConnect(data: onConnectPayload): Promise<void>;
+    onDisconnect(data: onDisconnectPayload): Promise<void>;
+    onUpgrade(data: onUpgradePayload): Promise<void>;
+    onRequest(data: onRequestPayload): Promise<void>;
+    onListen(data: onListenPayload): Promise<void>;
+    onDestroy(data: onDestroyPayload): Promise<void>;
+    onConfigure(data: onConfigurePayload): Promise<void>;
+    private logRawText;
+    private log;
+}

package/dist/packages/extension-logger/src/index.d.ts

@@ -0,0 +1 @@
+export * from './Logger';

package/dist/packages/{monitor → extension-monitor}/src/Collector.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { Configuration, onConnectPayload, onDisconnectPayload, onCreateDocumentPayload, onChangePayload } from '@hocuspocus/server';
+import { Configuration, onConnectPayload, onDisconnectPayload, onLoadDocumentPayload, onChangePayload } from '@hocuspocus/server';
 export declare class Collector {
     serverConfiguration: Partial<Configuration>;
     version: string;
@@ -30,7 +30,7 @@ export declare class Collector {
     connectionCount(): {
         count: string | number;
     };
-    createDocument(data: onCreateDocumentPayload): {
+    createDocument(data: onLoadDocumentPayload): {
         action: string;
         document: any;
         documentName: string;

package/dist/packages/{monitor → extension-monitor}/src/Dashboard.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { IncomingMessage, ServerResponse } from 'http';
-import WebSocket from 'ws';
+import WebSocket, { WebSocketServer } from 'ws';
 import { Socket } from 'net';
 import { Storage } from './Storage';
 export interface Configuration {
@@ -12,7 +12,7 @@ export interface Configuration {
 }
 export declare class Dashboard {
     configuration: Configuration;
-    websocketServer: WebSocket.Server;
+    websocketServer: WebSocketServer;
     connections: Map<WebSocket, any>;
     /**
      * Constructor

package/dist/packages/{monitor → extension-monitor}/src/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onCreateDocumentPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
+import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
 import { IncomingMessage, ServerResponse } from 'http';
 import WebSocket from 'ws';
 import { Storage } from './Storage';
@@ -32,7 +32,7 @@ export declare class Monitor implements Extension {
     onUpgrade({ request, socket, head }: onUpgradePayload): Promise<void>;
     onConnect(data: onConnectPayload): Promise<void>;
     onDisconnect(data: onDisconnectPayload): Promise<void>;
-    onCreateDocument(data: onCreateDocumentPayload): Promise<void>;
+    onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
     onChange(data: onChangePayload): Promise<void>;
     onConfigure(data: onConfigurePayload): Promise<void>;
 }

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

@@ -1,5 +1,5 @@
 import { RedisPersistence } from 'y-redis';
-import { Extension, onConnectPayload, onCreateDocumentPayload, onDisconnectPayload } from '@hocuspocus/server';
+import { Extension, onConnectPayload, onLoadDocumentPayload, onDisconnectPayload } from '@hocuspocus/server';
 export interface Configuration {
 }
 export declare class Redis implements Extension {
@@ -10,7 +10,7 @@ export declare class Redis implements Extension {
      * Constructor
      */
     constructor(configuration?: Partial<Configuration>);
-    onCreateDocument(data: onCreateDocumentPayload): Promise<import("yjs").Doc | undefined>;
+    onLoadDocument(data: onLoadDocumentPayload): Promise<import("yjs").Doc | undefined>;
     onConnect(data: onConnectPayload): Promise<void>;
     onDisconnect(data: onDisconnectPayload): Promise<void>;
 }

package/dist/packages/{rocksdb → extension-rocksdb}/src/index.d.ts

@@ -1,4 +1,4 @@
-import { Extension, onCreateDocumentPayload } from '@hocuspocus/server';
+import { Extension, onLoadDocumentPayload } from '@hocuspocus/server';
 import { LeveldbPersistence } from 'y-leveldb';
 export interface Configuration {
     options: object | undefined;
@@ -12,9 +12,9 @@ export declare class RocksDB implements Extension {
      */
     constructor(configuration?: Partial<Configuration>);
     /**
-     * onCreateDocument hook
+     * onLoadDocument hook
      */
-    onCreateDocument(data: onCreateDocumentPayload): Promise<any>;
+    onLoadDocument(data: onLoadDocumentPayload): Promise<any>;
     /**
      * store updates in y-leveldb persistence
      */

package/dist/packages/{webhook → extension-webhook}/src/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { Extension, onChangePayload, onConnectPayload, onCreateDocumentPayload, onDisconnectPayload } from '@hocuspocus/server';
+import { Extension, onChangePayload, onConnectPayload, onLoadDocumentPayload, onDisconnectPayload } from '@hocuspocus/server';
 import { Doc } from 'yjs';
 import { Transformer } from '@hocuspocus/transformer';
 import { AxiosResponse } from 'axios';
@@ -42,15 +42,15 @@ export declare class Webhook implements Extension {
     /**
      * Send a request to the given url containing the given data
      */
-    sendRequest(event: Events, payload: any): Promise<AxiosResponse<any>>;
+    sendRequest(event: Events, payload: any): Promise<AxiosResponse<unknown, any>>;
     /**
      * onChange hook
      */
     onChange(data: onChangePayload): Promise<void>;
     /**
-     * onCreateDocument hook
+     * onLoadDocument hook
      */
-    onCreateDocument(data: onCreateDocumentPayload): Promise<void>;
+    onLoadDocument(data: onLoadDocumentPayload): Promise<void>;
     /**
      * onConnect hook
      */

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

@@ -1,7 +1,7 @@
 import * as Y from 'yjs';
 import { Awareness } from 'y-protocols/awareness';
 import * as mutex from 'lib0/mutex';
-import { CloseEvent, MessageEvent, OpenEvent } from 'ws';
+import { Event, CloseEvent, MessageEvent } from 'ws';
 import EventEmitter from './EventEmitter';
 import { OutgoingMessage } from './OutgoingMessage';
 import { ConstructableOutgoingMessage } from './types';
@@ -93,7 +93,7 @@ export interface HocuspocusProviderOptions {
     onAuthenticationFailed: ({ reason }: {
         reason: string;
     }) => void;
-    onOpen: (event: OpenEvent) => void;
+    onOpen: (event: Event) => void;
     onConnect: () => void;
     onMessage: (event: MessageEvent) => void;
     onOutgoingMessage: (message: OutgoingMessage) => void;
@@ -108,7 +108,7 @@ export interface HocuspocusProviderOptions {
 export declare class HocuspocusProvider extends EventEmitter {
     options: HocuspocusProviderOptions;
     subscribedToBroadcastChannel: boolean;
-    webSocket: any;
+    webSocket: WebSocket | null;
     shouldConnect: boolean;
     status: WebSocketStatus;
     isSynced: boolean;
@@ -141,7 +141,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     set synced(state: boolean);
     get isAuthenticationRequired(): boolean;
     disconnect(): void;
-    onOpen(event: OpenEvent): void;
+    onOpen(event: Event): void;
     getToken(): Promise<string | null>;
     webSocketConnectionEstablished(): Promise<void>;
     startSync(): void;

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

@@ -1,9 +1,10 @@
 /// <reference types="node" />
-import WebSocket from 'ws';
+import WebSocket, { WebSocketServer } from 'ws';
 import { IncomingMessage, Server as HTTPServer } from 'http';
 import { Configuration } from './types';
 import { MessageLogger } from './Debugger';
 export declare const defaultConfiguration: {
+    name: null;
     port: number;
     timeout: number;
 };
@@ -14,7 +15,7 @@ export declare class Hocuspocus {
     configuration: Configuration;
     documents: Map<any, any>;
     httpServer?: HTTPServer;
-    webSocketServer?: WebSocket.Server;
+    webSocketServer?: WebSocketServer;
     debugger: MessageLogger;
     /**
      * Configure the server

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

@@ -34,7 +34,11 @@ export interface Extension {
     onChange?(data: onChangePayload): Promise<any>;
     onConnect?(data: onConnectPayload): Promise<any>;
     onConfigure?(data: onConfigurePayload): Promise<any>;
-    onCreateDocument?(data: onCreateDocumentPayload): Promise<any>;
+    /**
+     * @deprecated onCreateDocument is deprecated, use onLoadDocument instead
+     */
+    onCreateDocument?(data: onLoadDocumentPayload): Promise<any>;
+    onLoadDocument?(data: onLoadDocumentPayload): Promise<any>;
     onDestroy?(data: onDestroyPayload): Promise<any>;
     onDisconnect?(data: onDisconnectPayload): Promise<any>;
     onListen?(data: onListenPayload): Promise<any>;
@@ -42,6 +46,10 @@ export interface Extension {
     onUpgrade?(data: onUpgradePayload): Promise<any>;
 }
 export interface Configuration extends Extension {
+    /**
+     * A name for the instance, used for logging.
+     */
+    name: string | null;
     /**
      * A list of hocuspocus extenions.
      */
@@ -73,7 +81,7 @@ export interface onConnectPayload {
     socketId: string;
     connection: ConnectionConfig;
 }
-export interface onCreateDocumentPayload {
+export interface onLoadDocumentPayload {
     context: any;
     document: Document;
     documentName: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/provider",
-  "version": "1.0.0-alpha.18",
+  "version": "1.0.0-alpha.22",
   "description": "hocuspocus provider",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -15,8 +15,13 @@
   "module": "dist/hocuspocus-provider.esm.js",
   "types": "dist/packages/provider/src/index.d.ts",
   "exports": {
-    "import": "./dist/hocuspocus-provider.esm.js",
-    "require": "./dist/hocuspocus-provider.cjs"
+    "development": {
+      "import": "./src"
+    },
+    "default": {
+      "import": "./dist/hocuspocus-provider.esm.js",
+      "require": "./dist/hocuspocus-provider.cjs"
+    }
   },
   "files": [
     "src",
@@ -26,9 +31,9 @@
     "@lifeomic/attempt": "^3.0.0",
     "lib0": "^0.2.42",
     "y-protocols": "^1.0.5",
-    "yjs": "^13.5.8"
+    "yjs": "^13.5.0"
   },
-  "gitHead": "b3f043fa2f99dd35bd68940efcb0d5b86a165585",
+  "gitHead": "f9f5acf828d4a1f5ae4df8188000b5c3873e18cf",
   "publishConfig": {
     "access": "public"
   }

package/src/HocuspocusProvider.ts

@@ -4,7 +4,7 @@ import * as time from 'lib0/time'
 import { Awareness, removeAwarenessStates } from 'y-protocols/awareness'
 import * as mutex from 'lib0/mutex'
 import * as url from 'lib0/url'
-import { CloseEvent, MessageEvent, OpenEvent } from 'ws'
+import { Event, CloseEvent, MessageEvent } from 'ws'
 import { retry } from '@lifeomic/attempt'
 import EventEmitter from './EventEmitter'
 import { IncomingMessage } from './IncomingMessage'
@@ -105,7 +105,7 @@ export interface HocuspocusProviderOptions {
   timeout: number,
   onAuthenticated: () => void,
   onAuthenticationFailed: ({ reason }: { reason: string }) => void,
-  onOpen: (event: OpenEvent) => void,
+  onOpen: (event: Event) => void,
   onConnect: () => void,
   onMessage: (event: MessageEvent) => void,
   onOutgoingMessage: (message: OutgoingMessage) => void,
@@ -167,7 +167,7 @@ export class HocuspocusProvider extends EventEmitter {
 
   subscribedToBroadcastChannel = false
 
-  webSocket: any = null
+  webSocket: WebSocket | null = null
 
   shouldConnect = true
 
@@ -287,14 +287,15 @@ export class HocuspocusProvider extends EventEmitter {
   createWebSocketConnection() {
     return new Promise((resolve, reject) => {
       // Init the WebSocket connection
-      this.webSocket = new this.options.WebSocketPolyfill(this.url)
-      this.webSocket.binaryType = 'arraybuffer'
-      this.webSocket.onmessage = this.onMessage.bind(this)
-      this.webSocket.onclose = this.onClose.bind(this)
-      this.webSocket.onopen = this.onOpen.bind(this)
-      this.webSocket.onerror = () => {
+      const ws = new this.options.WebSocketPolyfill(this.url)
+      ws.binaryType = 'arraybuffer'
+      ws.onmessage = this.onMessage.bind(this)
+      ws.onclose = this.onClose.bind(this)
+      ws.onopen = this.onOpen.bind(this)
+      ws.onerror = () => {
         reject()
       }
+      this.webSocket = ws
 
       // Reset the status
       this.synced = false
@@ -345,7 +346,7 @@ export class HocuspocusProvider extends EventEmitter {
 
     // No message received in a long time, not even your own
     // Awareness updates, which are updated every 15 seconds.
-    this.webSocket.close()
+    this.webSocket?.close()
   }
 
   forceSync() {
@@ -444,7 +445,7 @@ export class HocuspocusProvider extends EventEmitter {
     }
   }
 
-  onOpen(event: OpenEvent) {
+  onOpen(event: Event) {
     this.emit('open', { event })
 
     if (this.status !== WebSocketStatus.Connected) {

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

@@ -1,13 +0,0 @@
-import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onCreateDocumentPayload, onDestroyPayload, onDisconnectPayload, onListenPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
-export declare class Logger implements Extension {
-    onCreateDocument(data: onCreateDocumentPayload): Promise<void>;
-    onChange(data: onChangePayload): Promise<void>;
-    onConnect(data: onConnectPayload): Promise<void>;
-    onDisconnect(data: onDisconnectPayload): Promise<void>;
-    onUpgrade(data: onUpgradePayload): Promise<void>;
-    onRequest(data: onRequestPayload): Promise<void>;
-    onListen(data: onListenPayload): Promise<void>;
-    onDestroy(data: onDestroyPayload): Promise<void>;
-    onConfigure(data: onConfigurePayload): Promise<void>;
-    private static log;
-}