@hocuspocus/provider 1.0.0-alpha.24 → 1.0.0-alpha.28

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

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

package/dist/packages/extension-database/src/Database.d.ts

@@ -0,0 +1,36 @@
+/// <reference types="node" />
+import { Extension, onChangePayload, onLoadDocumentPayload } from '@hocuspocus/server';
+export interface DatabaseConfiguration {
+    /**
+     * Pass a Promise to retrieve updates from your database. The Promise should resolve to
+     * an array of items with Y.js-compatible binary data.
+     */
+    fetchUpdates: ({ documentName }: {
+        documentName: string;
+    }) => Promise<Uint8Array[]>;
+    /**
+     * Pass a function to store updates in your database.
+     */
+    storeUpdate: ({ update, documentName }: {
+        update: Buffer;
+        documentName: string;
+    }) => void;
+}
+export declare class Database implements Extension {
+    /**
+     * Default configuration
+     */
+    configuration: DatabaseConfiguration;
+    /**
+     * Constructor
+     */
+    constructor(configuration: Partial<DatabaseConfiguration>);
+    /**
+     * Get stored data from the database.
+     */
+    onLoadDocument({ document, documentName }: onLoadDocumentPayload): Promise<any>;
+    /**
+     * Store new updates in the database.
+     */
+    onChange({ document, documentName }: onChangePayload): Promise<void>;
+}

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

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

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

@@ -1,4 +1,4 @@
-import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDestroyPayload, onDisconnectPayload, onListenPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
+import { Extension, onChangePayload, onConfigurePayload, onConnectPayload, onLoadDocumentPayload, onDestroyPayload, onDisconnectPayload, onRequestPayload, onUpgradePayload } from '@hocuspocus/server';
 export interface LoggerConfiguration {
     /**
      * Prepend all logging message with a string.
@@ -30,10 +30,6 @@ export interface LoggerConfiguration {
      * 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.
      */
@@ -54,15 +50,13 @@ export declare class Logger implements Extension {
      * Constructor
      */
     constructor(configuration?: Partial<LoggerConfiguration>);
+    onConfigure(data: onConfigurePayload): Promise<void>;
     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-sqlite/src/SQLite.d.ts

@@ -0,0 +1,26 @@
+import { Database, DatabaseConfiguration } from '@hocuspocus/extension-database';
+import sqlite3 from 'sqlite3';
+export interface SQLiteConfiguration extends DatabaseConfiguration {
+    /**
+     * Valid values are filenames, ":memory:" for an anonymous in-memory database and an empty
+     * string for an anonymous disk-based database. Anonymous databases are not persisted and
+     * when closing the database handle, their contents are lost.
+     *
+     * https://github.com/mapbox/node-sqlite3/wiki/API#new-sqlite3databasefilename-mode-callback
+     */
+    database: string;
+    /**
+     * The database schema to create.
+     */
+    schema: string;
+}
+export declare class SQLite extends Database {
+    db?: sqlite3.Database;
+    configuration: SQLiteConfiguration;
+    /**
+     * Constructor
+     */
+    constructor(configuration?: Partial<SQLiteConfiguration>);
+    onListen(): Promise<void>;
+    onConfigure(): Promise<void>;
+}

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

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

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

@@ -42,7 +42,7 @@ export declare class Webhook implements Extension {
     /**
      * Send a request to the given url containing the given data
      */
-    sendRequest(event: Events, payload: any): Promise<AxiosResponse<unknown, any>>;
+    sendRequest(event: Events, payload: any): Promise<AxiosResponse<any, any>>;
     /**
      * onChange hook
      */

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

@@ -0,0 +1,10 @@
+import { HocuspocusProvider, HocuspocusProviderOptions } from './HocuspocusProvider';
+export interface HocuspocusCloudProviderOptions extends HocuspocusProviderOptions {
+    /**
+     * A Hocuspocus Cloud key, get one here: https://hocuspocus.cloud/
+     */
+    key: string;
+}
+export declare class HocuspocusCloudProvider extends HocuspocusProvider {
+    constructor(options: HocuspocusCloudProviderOptions);
+}

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

@@ -130,7 +130,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     get awareness(): Awareness;
     checkConnection(): void;
     forceSync(): void;
-    registerBeforeUnloadEventListener(): void;
+    registerEventListeners(): void;
     documentUpdateHandler(update: Uint8Array, origin: any): void;
     awarenessUpdateHandler({ added, updated, removed }: any, origin: any): void;
     permissionDeniedHandler(reason: string): void;

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

@@ -1,3 +1,4 @@
 export * from './HocuspocusProvider';
+export * from './HocuspocusCloudProvider';
 export * from './types';
 export * from './utils';

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

@@ -1,15 +1,17 @@
 /// <reference types="node" />
 import WebSocket, { WebSocketServer } from 'ws';
 import { IncomingMessage, Server as HTTPServer } from 'http';
-import { Configuration } from './types';
+import { Configuration, Hook } from './types';
 import { MessageLogger } from './Debugger';
+import { onListenPayload } from '.';
 export declare const defaultConfiguration: {
     name: null;
     port: number;
     timeout: number;
+    quiet: boolean;
 };
 /**
- * Hocuspocus server
+ * Hocuspocus Server
  */
 export declare class Hocuspocus {
     configuration: Configuration;
@@ -25,7 +27,8 @@ export declare class Hocuspocus {
     /**
      * Start the server
      */
-    listen(): Promise<void>;
+    listen(portOrCallback?: number | ((data: onListenPayload) => Promise<any>) | null, callback?: any): Promise<void>;
+    private showStartScreen;
     /**
      * Get the total number of active documents
      */
@@ -64,9 +67,8 @@ export declare class Hocuspocus {
     /**
      * Run the given hook on all configured extensions
      * Runs the given callback after each hook
-     * @private
      */
-    private hooks;
+    hooks(name: Hook, payload: any, callback?: Function | null): Promise<any>;
     /**
      * Get parameters by the given request
      * @private
@@ -76,7 +78,7 @@ export declare class Hocuspocus {
      * Get document name by the given request
      * @private
      */
-    private static getDocumentName;
+    private getDocumentNameFromRequest;
     enableDebugging(): void;
     enableMessageLogging(): void;
     disableLogging(): void;

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

@@ -67,6 +67,18 @@ export interface Configuration extends Extension {
      * Defines in which interval the server sends a ping, and closes the connection when no pong is sent back.
      */
     timeout: number;
+    /**
+     * By default, the servers show a start screen. If passed false, the server will start quietly.
+     */
+    quiet: boolean;
+    /**
+     * Function which returns the (customized) document name based on the request
+     */
+    getDocumentName?(data: {
+        documentName: string;
+        request: IncomingMessage;
+        requestParameters: URLSearchParams;
+    }): string | Promise<string>;
 }
 export interface onAuthenticatePayload {
     documentName: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/provider",
-  "version": "1.0.0-alpha.24",
+  "version": "1.0.0-alpha.28",
   "description": "hocuspocus provider",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -28,13 +28,10 @@
     "dist"
   ],
   "dependencies": {
-    "@lifeomic/attempt": "^3.0.0",
-    "lib0": "^0.2.42",
+    "@lifeomic/attempt": "^3.0.1",
+    "lib0": "^0.2.43",
     "y-protocols": "^1.0.5",
-    "yjs": "^13.5.0"
+    "yjs": "^13.5.22"
   },
-  "gitHead": "53a194759b3bfbea5cf22bab39e3788021387f69",
-  "publishConfig": {
-    "access": "public"
-  }
+  "gitHead": "8ffe8d8f4d10ba33f4f203806bd1d4415bef5dc3"
 }

package/src/HocuspocusCloudProvider.ts

@@ -0,0 +1,26 @@
+import { HocuspocusProvider, HocuspocusProviderOptions } from './HocuspocusProvider'
+
+export interface HocuspocusCloudProviderOptions extends HocuspocusProviderOptions {
+  /**
+   * A Hocuspocus Cloud key, get one here: https://hocuspocus.cloud/
+   */
+  key: string,
+}
+
+export class HocuspocusCloudProvider extends HocuspocusProvider {
+  constructor(options: HocuspocusCloudProviderOptions) {
+    if (!options.url) {
+      options.url = 'wss://connect.hocuspocus.cloud'
+    }
+
+    if (options.key) {
+      if (!options.parameters) {
+        options.parameters = {}
+      }
+
+      options.parameters.key = options.key
+    }
+
+    super(options as HocuspocusProviderOptions)
+  }
+}

package/src/HocuspocusProvider.ts

@@ -195,6 +195,7 @@ export class HocuspocusProvider extends EventEmitter {
     super()
     this.setOptions(options)
 
+    this.options.document = options.document ? options.document : new Y.Doc()
     this.options.awareness = options.awareness ? options.awareness : new Awareness(this.document)
     this.options.WebSocketPolyfill = options.WebSocketPolyfill ? options.WebSocketPolyfill : WebSocket
 
@@ -222,7 +223,7 @@ export class HocuspocusProvider extends EventEmitter {
 
     this.document.on('update', this.documentUpdateHandler.bind(this))
     this.awareness.on('update', this.awarenessUpdateHandler.bind(this))
-    this.registerBeforeUnloadEventListener()
+    this.registerEventListeners()
 
     this.intervals.connectionChecker = setInterval(
       this.checkConnection.bind(this),
@@ -357,11 +358,12 @@ export class HocuspocusProvider extends EventEmitter {
     this.send(SyncStepOneMessage, { document: this.document })
   }
 
-  registerBeforeUnloadEventListener() {
+  registerEventListeners() {
     if (typeof window === 'undefined') {
       return
     }
 
+    window.addEventListener('online', this.connect.bind(this))
     window.addEventListener('beforeunload', () => {
       removeAwarenessStates(this.awareness, [this.document.clientID], 'window unload')
     })
@@ -579,6 +581,12 @@ export class HocuspocusProvider extends EventEmitter {
     this.document.off('update', this.documentUpdateHandler)
 
     this.removeAllListeners()
+
+    if (typeof window === 'undefined') {
+      return
+    }
+
+    window.removeEventListener('online', this.connect.bind(this))
   }
 
   get broadcastChannel() {

package/src/MessageReceiver.ts

@@ -1,9 +1,9 @@
 import * as awarenessProtocol from 'y-protocols/awareness'
 import { readSyncMessage, messageYjsSyncStep2 } from 'y-protocols/sync'
+import { readAuthMessage } from '@hocuspocus/common'
 import { MessageType } from './types'
 import { HocuspocusProvider } from './HocuspocusProvider'
 import { IncomingMessage } from './IncomingMessage'
-import { readAuthMessage } from '../../../shared/protocols/auth'
 import { OutgoingMessage } from './OutgoingMessage'
 
 export class MessageReceiver {

package/src/OutgoingMessages/AuthenticationMessage.ts

@@ -1,5 +1,5 @@
 import { writeVarUint } from 'lib0/encoding'
-import { writeAuthentication } from '../../../../shared/protocols/auth'
+import { writeAuthentication } from '@hocuspocus/common'
 import { MessageType, OutgoingMessageArguments } from '../types'
 import { OutgoingMessage } from '../OutgoingMessage'
 

package/src/index.ts

@@ -1,3 +1,4 @@
 export * from './HocuspocusProvider'
+export * from './HocuspocusCloudProvider'
 export * from './types'
 export * from './utils'