@hocuspocus/provider 1.0.0-alpha.25 → 1.0.0-alpha.29

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

@@ -0,0 +1,23 @@
+export interface CloseEvent {
+    code: number;
+    reason: string;
+}
+/**
+ * The server successfully processed the request, asks that the requester reset
+ * its document view, and is not returning any content.
+ */
+export declare const ResetConnection: CloseEvent;
+/**
+ * Similar to Forbidden, but specifically for use when authentication is required and has
+ * failed or has not yet been provided.
+ */
+export declare const Unauthorized: CloseEvent;
+/**
+ * The request contained valid data and was understood by the server, but the server
+ * is refusing action.
+ */
+export declare const Forbidden: CloseEvent;
+/**
+ * The server timed out waiting for the request.
+ */
+export declare const ConnectionTimeout: CloseEvent;

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

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

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,11 @@
+import { HocuspocusProvider, HocuspocusProviderConfiguration } from './HocuspocusProvider';
+export declare type HocuspocusCloudProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & AdditionalHocuspocusCloudProviderConfiguration;
+export interface AdditionalHocuspocusCloudProviderConfiguration {
+    /**
+     * A Hocuspocus Cloud key, get one here: https://hocuspocus.cloud/
+     */
+    key: string;
+}
+export declare class HocuspocusCloudProvider extends HocuspocusProvider {
+    constructor(configuration: HocuspocusCloudProviderConfiguration);
+}

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

@@ -10,7 +10,8 @@ export declare enum WebSocketStatus {
     Connected = "connected",
     Disconnected = "disconnected"
 }
-export interface HocuspocusProviderOptions {
+export declare type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, 'url' | 'name'>> & Partial<CompleteHocuspocusProviderConfiguration>;
+export interface CompleteHocuspocusProviderConfiguration {
     /**
      * URL of your @hocuspocus/server instance
      */
@@ -104,9 +105,13 @@ export interface HocuspocusProviderOptions {
     onDestroy: () => void;
     onAwarenessUpdate: (states: any) => void;
     onAwarenessChange: (states: any) => void;
+    /**
+     * Don’t output any warnings.
+     */
+    quiet: boolean;
 }
 export declare class HocuspocusProvider extends EventEmitter {
-    options: HocuspocusProviderOptions;
+    configuration: CompleteHocuspocusProviderConfiguration;
     subscribedToBroadcastChannel: boolean;
     webSocket: WebSocket | null;
     shouldConnect: boolean;
@@ -120,8 +125,8 @@ export declare class HocuspocusProvider extends EventEmitter {
         resolve: (value?: any) => void;
         reject: (reason?: any) => void;
     } | null;
-    constructor(options?: Partial<HocuspocusProviderOptions>);
-    setOptions(options?: Partial<HocuspocusProviderOptions>): void;
+    constructor(configuration: HocuspocusProviderConfiguration);
+    setConfiguration(configuration?: Partial<HocuspocusProviderConfiguration>): void;
     connect(): Promise<void>;
     createWebSocketConnection(): Promise<unknown>;
     resolveConnectionAttempt(): void;
@@ -130,7 +135,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/Connection.d.ts

@@ -2,8 +2,8 @@
 import AsyncLock from 'async-lock';
 import WebSocket from 'ws';
 import { IncomingMessage as HTTPIncomingMessage } from 'http';
+import { CloseEvent } from '@hocuspocus/common';
 import Document from './Document';
-import { CloseEvent } from './types';
 import { MessageLogger } from './Debugger';
 declare class Connection {
     webSocket: WebSocket;

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

@@ -3,13 +3,15 @@ import WebSocket, { WebSocketServer } from 'ws';
 import { IncomingMessage, Server as HTTPServer } from 'http';
 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;
@@ -21,11 +23,12 @@ export declare class Hocuspocus {
      * Configure the server
      */
     configure(configuration: Partial<Configuration>): Hocuspocus;
-    get authenticationRequired(): boolean;
+    get requiresAuthentication(): boolean;
     /**
      * 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
      */
@@ -43,7 +46,14 @@ export declare class Hocuspocus {
      */
     destroy(): Promise<any>;
     /**
-     * Handle the incoming WebSocket connection
+     * The `handleConnection` method 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.
      */
     handleConnection(incoming: WebSocket, request: IncomingMessage, documentName: string, context?: any): void;
     /**
@@ -75,7 +85,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

@@ -25,8 +25,9 @@ export interface AwarenessUpdate {
     updated: Array<any>;
     removed: Array<any>;
 }
-export interface ConnectionConfig {
+export interface ConnectionConfiguration {
     readOnly: boolean;
+    requiresAuthentication: boolean;
     isAuthenticated: boolean;
 }
 export interface Extension {
@@ -67,6 +68,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;
@@ -75,7 +88,7 @@ export interface onAuthenticatePayload {
     requestParameters: URLSearchParams;
     socketId: string;
     token: string;
-    connection: ConnectionConfig;
+    connection: ConnectionConfiguration;
 }
 export interface onConnectPayload {
     documentName: string;
@@ -84,7 +97,7 @@ export interface onConnectPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfig;
+    connection: ConnectionConfiguration;
 }
 export interface onLoadDocumentPayload {
     context: any;
@@ -94,7 +107,7 @@ export interface onLoadDocumentPayload {
     requestHeaders: IncomingHttpHeaders;
     requestParameters: URLSearchParams;
     socketId: string;
-    connection: ConnectionConfig;
+    connection: ConnectionConfiguration;
 }
 export interface onChangePayload {
     clientsCount: number;
@@ -140,7 +153,3 @@ export interface onConfigurePayload {
     yjsVersion: string;
     instance: Hocuspocus;
 }
-export interface CloseEvent {
-    code: number;
-    reason: string;
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hocuspocus/provider",
-  "version": "1.0.0-alpha.25",
+  "version": "1.0.0-alpha.29",
   "description": "hocuspocus provider",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
@@ -28,13 +28,11 @@
     "dist"
   ],
   "dependencies": {
-    "@lifeomic/attempt": "^3.0.0",
-    "lib0": "^0.2.42",
+    "@hocuspocus/common": "^1.0.0-alpha.4",
+    "@lifeomic/attempt": "^3.0.1",
+    "lib0": "^0.2.43",
     "y-protocols": "^1.0.5",
-    "yjs": "^13.5.0"
+    "yjs": "^13.5.22"
   },
-  "gitHead": "cd788b6a315f608ef531524409abdce1e6790726",
-  "publishConfig": {
-    "access": "public"
-  }
+  "gitHead": "87b715d1d28c603702879f4413c17d2c4a38c51a"
 }

package/src/HocuspocusCloudProvider.ts

@@ -0,0 +1,34 @@
+import {
+  HocuspocusProvider,
+  HocuspocusProviderConfiguration,
+} from './HocuspocusProvider'
+
+export type HocuspocusCloudProviderConfiguration =
+  Required<Pick<HocuspocusProviderConfiguration, 'name'>> &
+  Partial<HocuspocusProviderConfiguration> &
+  AdditionalHocuspocusCloudProviderConfiguration
+
+export interface AdditionalHocuspocusCloudProviderConfiguration {
+  /**
+   * A Hocuspocus Cloud key, get one here: https://hocuspocus.cloud/
+   */
+  key: string,
+}
+
+export class HocuspocusCloudProvider extends HocuspocusProvider {
+  constructor(configuration: HocuspocusCloudProviderConfiguration) {
+    if (!configuration.url) {
+      configuration.url = 'wss://connect.hocuspocus.cloud'
+    }
+
+    if (configuration.key) {
+      if (!configuration.parameters) {
+        configuration.parameters = {}
+      }
+
+      configuration.parameters.key = configuration.key
+    }
+
+    super(configuration as HocuspocusProviderConfiguration)
+  }
+}